Magento Commerce 2.3 User Guide PDF
Magento Commerce 2.3 User Guide PDF
Magento Commerce 2.3 User Guide PDF
oCommer
ce
Ver
sion2.
3
Contents
GETTING STARTED 1
CHAPTER 1: Welcome 3
Resources 4
Installation 10
Prelaunch Checklist 11
Creating an Account 16
Path to Purchase 24
Home Page 26
Catalog Page 28
Search Results 30
Product Page 32
Shopping Cart 34
Customer Journey 36
Moment of Purchase 42
Retain Customers 44
Success! 47
Basic Configuration 48
Admin Sign In 51
Admin Sidebar 54
Admin Workspace 56
Dashboard 62
Message Inbox 66
Global Search 69
Grid Controls 70
Grid Layout 72
Actions Control 74
Store Information 81
Locale Options 83
State Options 84
Country Options 85
Merchant Location 87
Currency 88
Contact Us 91
Scope 111
Accessibility 141
CATALOG 143
Content 245
Configurations 246
Up-sells 252
Cross-sells 254
Design 263
Autosettings 264
Placeholders 391
Watermarks 392
Swatches 395
MARKETING 462
Ratings 489
Promotions 491
Merchandising 549
Invitations 601
Communications 604
MySQL 766
Elasticsearch 768
CHANNELS 848
Stock/Quantity 1023
Fulfilled By 1026
Overrides 1101
CONTENT 1162
Workspace 1333
Stage 1334
Panel 1335
Toolbox 1336
Layout 1337
Row 1338
Column 1350
Tabs 1360
Elements 1372
Text 1373
Heading 1378
Divider 1384
Buttons 1390
Media 1406
Image 1407
Video 1420
Banner 1426
Slider 1442
Map 1465
Header 1502
Footer 1503
CUSTOMERS 1550
My Orders 1592
SALES 1631
Remember Me 1666
Dispatches 1754
Batches 1756
Payments 1801
Requirements 1804
Braintree 1827
Requirements 1838
Requirements 1841
Requirements 1847
Requirements 1850
Klarna 1864
Authorize.net 1899
CyberSource 1902
eWAY 1905
Worldpay 1908
Shipping 1928
Returns 1955
Locations 1964
Packaging 1972
Troubleshooting 1990
REPORTS 2012
Reports 2019
Reports 2023
Reports 2027
Reports 2029
Reports 2033
Dashboards 2049
Filters 2058
Formulas 2062
Metrics 2069
OPERATIONS 2094
Stores 2095
System 2231
Import 2243
Export 2254
Be Prepared! 2332
CAPTCHA 2339
Backups 2388
Archive 2397
APPENDICES 2437
INDEX 2454
Best Practices for Product Attributes 2482
1
Contents
This section of the guide provides an overview Welcome
of the resources that are available to you as a
member of the Magento community. You’ll learn About This Guide
about the current release, and how to log into Resources
your Magento account. Finally, you’ll take a Join the Conversation!
guided tour of Magento from two different
About This Release
perspectives, with links you can explore to learn
more about each topic. System Requirements
Installation
Prelaunch Checklist
Your Login Credentials
For Your Records
Quick Tour
Path to Purchase
Home Page
Catalog Page
Search Results
Product Page
Shopping Cart
Customer Journey
Attract New Customers
Engage Your Customers
Moment of Purchase
Increase Average Order Value
Customer Retention
Loyalty & Advocacy
Success!
Basic Configuration
2
CHAPTER 1:
Welcome
Welcome to the next generation of the world’s leading digital commerce platform! Magento
Commerce provides online merchants with unparalleled flexibility and control over the look,
content, and functionality of their online stores. Magento’s intuitive Admin features powerful
marketing, search engine optimization, and product management tools that give you the power
to create sites that are tailored to your unique business needs. Robust and scalable, Magento
offers you a stable, secure, and customizable solution for your growing business.
Magento Advantage
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.
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.
Blog
Check out the Magento blog for the latest information
about new features, trends, best practices, upcoming
events, and more!
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.
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 on-
premise and cloud-based solutions.
Magento Forums
This is the place to find solutions, become acquainted
with international communities, and join a special interest
chat! Share your knowledge and earn kudos from others!
Facebook
Find out what’s happening and join the discussion on our
Facebook page!
Twitter
Follow us on Twitter!
LinkedIn
Join a Magento group on LinkedIn.
Google+
Add us to your circle on Google+.
YouTube
Learn while you watch videos on our YouTube channel!
Meetup
Find a Magento Meetup near you!
Magento Commerce
Installation
To download and install the latest release of Magento 2.3.x on your server, see the Installation
and Configuration in our technical documentation. The Magento installation can be deployed
to run in either production or developer mode. Some tools and configuration settings are
designed specifically for developers, and can be accessed only while the store is running in
developer mode. To learn more, see Magento Modes.
The Magento installation guide provides multiple options including download zip file,
Composer, and cloned code repository. We recommend reviewing the following information:
l System requirements
l Prerequisites
l Installation roadmap
l Post Installation
To update an existing installation, see Web Setup Wizard in the System section of this guide.
Prelaunch Checklist
After you complete the design, development, and testing of your store, check the following
configuration settings to make sure everything is correct before the store “goes live.” For a
comprehensive description of every configuration setting, see the Configuration Reference.
General Settings
Store URLs
Verify that the store URLs for the storefront and Admin are correct for a live production
environment.
Security Certificate
Before launching your store, install a 100% Signed and Trusted Security Certificate for
the domain specified in the Base URL.
Marketing Settings
Email Templates
Update the default email templates to reflect your brand. Make sure to update the
configuration if you create new templates.
Sales Communications
Make sure that your invoices and packing slips include the correct business information
and reflect your brand.
Google Tools
Magento is integrated with Google API to allow your business to use Google Analytics
and Google AdWords.
Checkout Options
Take a look at the checkout options, to see if there’s anything that you want to change.
This is where you can set up terms and conditions, and configure guest checkout.
Taxes
Make sure that taxes are properly configured according to your business tax rules and
local requirements.
Shipping Methods
Enable all carriers and shipping methods to be used by the company.
PayPal
If you plan to offer your customers the convenience of paying with PayPal, open a PayPal
Merchant Account, and set up a payment method. Run some test transactions in
Sandbox Mode before the store goes live.
Payment Methods
Enable the payment methods that you plan to use, and make sure that they are properly
configured. Check the order status settings, accepted currency, allowed countries, and
so on.
System Settings
Cron (Scheduled Tasks)
Cron jobs are used to process email, catalog price rules, newsletters, customer alerts,
Google sitemaps, update currency rates, and so on, Make sure that Cron jobs are set to
run at the appropriate time interval, in minutes.
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.
Store URL:
Admin URL:
Admin Password:
Admin Email
Address:
Magento Account
User Name:
Password:
Email Address:
User Name:
Password:
Email Address:
Installation Information
Installation Date:
Magento Version:
Encryption Key:
Database Name:
Database User Name:
Database Password:
Creating an Account
Anyone can open a free Magento account from our website. The email address that is used to
open a Magento account can be associated with only one account, and the screen name that
you enter becomes your identity in Magento forums.
2. In the upper-right corner, choose My Account. Then under New Customers, tap Register.
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.
Your screen name can be from four to fifteen characters long, can include numbers and the
underscore, but must start with a letter.
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.
Create an Account
3. Enter the Email address that is associated with your account. Then, enter 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.
2. In the panel on the left, choose Account Settings. Then, tap Change Password
If you forgot your password, enter the temporary password that was sent to you.
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.
Change Password
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
1. Before you begin, get the following information from the new user’s Magento account:
l Account ID
l Email address
3. In the panel on the left, under Shared Access, choose Add New User. Then, do the following:
l Enter the Email address that is associated with the new user’s 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.
You are notified when the new role is saved, and the new user record appears in the Manage
Permissions section of the Shared Access page. Magento also sends an email invitation with
instructions for accessing the shared account to the new user.
Manage Permissions
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.”
Customer Journey
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.”
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.
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 Appeal to a Lifestyle
l Shop by Fabric
l Popular Products
l Footer Content
l Subscribe!
Home Page
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 Breadcrumb Trail
l Go to Next Page
l Read a Review
Catalog Page
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 Next Page
l Advanced Search
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 A little help…
l Product Rating
l Stock Availability
l Zoom
l Buy it Now!
l Email a Friend
l Compare Products
l Thumbnail
l Product Details
l Related Products
Product Page
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 Go to Checkout
l Use a Coupon
l Cross-sells
l Special Price
Customer Journey
Attract New Customers
Magento Commerce includes SEO functionality out of
the box. Improve your search ranking and attract the
most visitors to your site.
Increase AOV
Increase average order value with promotions and
content that encourage your customers to shop more.
Moment of Purchase
Give your customers a faster and easier way to check
out. Calculate shipping and taxes automatically, and
integrate multiple payment methods on a single page.
Customer Retention
Create and manage newsletters and promotions to keep
your customers coming back for more.
Custom URLs
Custom URLs are short, clean, and easy to remember. You can also autogenerate search-friendly
URLs to streamline your purchase path.
Meta Data
Improve your search engine rankings by choosing specific criteria that helps search engines to find
and index your products more easily. Meta data can be entered for product, category, and content
pages.
Sitemap
Link to a sitemap from the footer of your store to give customers an overview of the catalog structure,
with links to all categories and products in the store. Easy integration with Google Sitemap.
Analytics
In addition to monitoring your site from the Admin dashboard, you can integrate third-party analytics
tools such as Google Analytics and New Relic Reporting for detailed statistics on traffic and sales.
Content Management
Magento’s Page Builder makes it easy to create targeted pages with interactive elements that engage
your customers. Even those without a technology background can create and manage content.
Multiple Devices
Magento’s powerful features make it easy to create storefronts optimized for iPhone, Android, and
Mobile Opera browsers to help you engage consumers with mobile commerce now, and into the
future.
Shopping Tools
Your store includes a set of shopping tools that create opportunities for your customers to interact
with your store, connect on social media, and share with friends.
Sophisticated Search
Filter product by price, manufacturer, or any other criteria to reduce the time to purchase.
Targeted Promotions
Use catalog and shopping cart price rules to create promotions that kick into gear when a set of
conditions is met. Segment customers dynamically and build segments based on specific
characteristics such as customer address, order history, shopping cart content, and much more.
Then, use Page Builder to create a dynamic block that is triggered by a promotion, and appears only
to the targeted customer segment.
Coupons
Create limited-time offers and coupons that customers can scan with their phone and apply to a
purchase.
Product Suggestions
Another way to increase AOV is to offer suggestions for related products and opportunities to up-sell
and cross-sell at strategic points along the path to conversion.
Email Reminders
Send automated reminder emails to customers who have added items to their carts or wish lists, but
haven’t made a purchase. A variety of triggers can launch automated emails, including total cart
value, quantity, items in the cart, and more.
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.
Archiving orders frees resources and improves performance when sales reps are assisting customers
with orders.
Index Management
Automatic reindexing takes place whenever prices change, shopping carts are updated, or new
categories created. Reindexing is a background process that does not interfere with store operations.
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.
Instant Purchase
Simplify ordering and boost conversion rates by allowing your customers to speed through checkout
by using stored payment and shipping information.
Shopping Assistance
Assisted shopping makes it easy for customer service reps to create orders for customers. Customer
service reps have access to shopping cart contents, and can move items from a wish list to a
shopping cart, apply coupon codes, and more.
Security
Whether an order is fulfilled online or over the phone, Magento provides sophisticated security,
including CAPTCHA and SSL encryption, with best-in-breed encryption and hashing algorithms to
protect the security of the system.
Order Processing
Magento supports a complete order processing workflow. It's easy to customize order statuses and
track communications between sales reps and customers.
Magento Shipping
Offer seamless access to global carrier networks, and use customer experience rules to streamline
operations and automate processes.
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.
Retain Customers
Magento makes it easy for you to get repeat business
and build brand loyalty. Magento gives you total control
and flexibility over creating and revising goodies like
rewards programs, custom coupons and automated
emails to keep your customers coming back again and
again.
RMA
Customers can submit requests for Return Merchandise Authorization from your store. You can
create shipment orders in a carrier system, and print shipping labels with RMA numbers.
Store Credit
Keep customers loyal and happy by issuing refunds as store credit or virtual gift cards to ensure that
the money they spend stays in your store.
Reward Points
Drive customer engagement with reward programs with award points based on a range of
transactions and customer behaviors. Base redemption on a variety of factors, such as balance,
customer history, and conversion rates.
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.
Advanced Reporting
Gain valuable insights at a glance with dynamic product, order, and customer reports, powered
by Magento Business Intelligence.
Dashboard Snapshots
Knowing what’s of interest on your site is crucial to maximize your marketing budget. Use this
information to determine what you should cross- and up-sell to loyal customers, or which products to
put on sale.
Customer Accounts
Opening an account provides customers with a personalized shopping experience that they can share
with their friends. Customers can save their shopping preferences, and manage their own store billing
and shipping information.
Advocacy Tools
Customers who share wish lists and send gift cards make a powerful endorsement of your brand.
Wish lists become powerful advocacy tools when shared by email or RSS feed, and gift cards bring
motivated new shoppers to your store.
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.
Shipping Methods
Magento shipping methods are easy to set up and give you the ability to connect with carriers who
can ship your products all over the world.
Taxes
Manage your taxes with our native tools, or add third-party extensions from Magento Marketplace.
48
Contents
This section of the guide introduces your store's Store Admin
Admin, and walks you through the basic
configuration settings. You’ll learn the concepts of Your Admin Account
store hierarchy and configuration scope, and Admin Sidebar
establish best practices for industry standards and Admin Workspace
requirements. Dashboard
Message InBox
Global Search
Grid Controls
Actions Control
Store Details
Store Information
Locale Options
State Options
Country Options
Merchant Location
Currency
Store Email Addresses
Contact Us
Storefront Branding
Configuration Scope
Single Store Mode
Industry Compliance
PCI Compliance
Privacy Policy
Cookie Law Compliance
Cookie Restriction Mode
Cookie Reference
49
CHAPTER 5:
Store Admin
Your store Admin is the password-protected back office where you, as the merchant, can set up
products, promotions, manage orders, and perform other administrative tasks. All basic
configuration tasks and store management operations are performed from the Admin.
In addition to the default Admin account, you can create as many additional accounts that are
needed to manage the store and to support customer accounts. Each account can be associated
with a specific role and level of access, based on the person’s business need to know. The email
address that is associated with each Admin account must be unique.
Admin Sign In
You will first learn how to sign in and out of the Admin and how to reset your password. All of
the instructions in the rest of this guide are written for a user with full administrative
privileges, and begin with the assumption that you are logged in to the Admin. To learn more
about Admin users and roles, see Permissions
The Advanced Admin configuration determines how many times an admin user can try to log
in before the account is locked. By default, six attempts are allowed. To unlock a user account,
see: Locked Users.
Depending on Admin configurations, you may also need to resolve a CAPTCHA or reCAPTCHA
or enter a configured Two-Factor Authentication code.
When entering your credentials, the username and password may automatically populate if
your browser is set to use the autocomplete function. If enabled, you can save your credentials
for the Magento Admin login page.
Admin Sign In
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. These values may populate depending on your
browser's autocomplete setting.
3. (Optional) You may need to resolve a CAPTCHA or reCAPTCHA or enter a configured Two-
Factor Authentication code.
4. Tap Login .
1. If you forget your password, click the Forgot Your Password? link. Then, enter the Email
Address that is associated with the Admin account.
Forgot Password
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.
In the upper-right corner, tap the Account ( ) icon. Then on the menu, choose Sign Out.
Sign Out
The Sign-In page displays, 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.
2. Make any changes necessary changes to your account information. If you change your login
credentials, make sure to write them down.
Account Information
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.
Catalog
The Catalog menu is used to create products and define categories.goo
Customers
The Customers menu is where you can manage customer accounts, and see
which customers are online at the moment.
Marketing
The Marketing menu is where you set up catalog and shopping cart price rules
and coupons. Price rules trigger actions when a set of specific conditions is met.
Content
The Content menu is where you manage the content elements and design of your
store. You will learn how to create pages, blocks, and frontend apps, and manage
the presentation of your store.
Reports
The Reports menu provides a broad selection of reports that give you insight into
every aspect of your store, including sales, shopping cart, products, customers,
tags, reviews, and search terms.
Stores
The Stores menu includes tools to configure and maintain every aspect of your
store, including multisite installation settings, taxes, currency, product attributes,
and customer groups.
System
The System menu includes tools to manage system operations, install
extensions, and manage Web Services for integration with other applications.
Admin Workspace
The Admin workspace provides access to all the tools, data, and content that you need to run
your store. The default start up page can be set in the configuration. Many Admin pages have a
grid that lists the data for the section, with a set of tools to search, sort, filter, select, and apply
actions. By default, the Dashboard is the startup page for the Admin. However, you can choose
any other page to appear as the startup page when you log in. You can tap the Magento logo in
the Admin sidebar to return to the Admin startup page.
Admin Workspace
4. Set Startup Page to the page that you want to appear first after you log in to the Admin.
Startup Page
Workspace Controls
CONTROL DESCRIPTION
Search The Global Search box can be used to find any value in the database,
including product, customer, and order records.
Sort The header of each column can be used to sort the list in ascending or
descending order.
Filters Defines a set of search parameters that determines the records that appear in
the grid.
In addition, the filters in the header of some columns can be used to limit the
list to specific values. Some filters have additional options that can be
selected from a list box, and for others, you can simply type the value you
want to find.
Columns Determines the selection of columns and their order in the grid. The column
layout can be changed. and saved as a “view.” By default, only some of the
columns are included in the grid.
Paginate The pagination controls are used to view the additional pages of results.
Actions The Actions control applies an operation to all selected records. To select
individual records, mark the checkbox in the first column of each row, or use
the Select control.
Select The Select control is used to select multiple records that are to be the target
of action. Options: Select All / Deselect All
Archive Orders
Invoices
Shipments
Credit Memos
Catalog Products
Categories
Design Configuration
Themes
Schedule
Reviews By Customers
By Products
Sales Orders
Tax
Invoiced
Shipping
Refunds
Coupons
PayPal Settlement
Braintree Settlement
Products Views
Bestsellers
Low Stock
Ordered
Downloads
Attributes Customer
Customer Address
Product
Attribute Set
Returns
Rating
Extensions Integrations
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
Enable Charts
2. In the Dashboard section, clear the Use system value checkbox and set Enable Charts to
“Yes.”
Enable Charts
Beginning Date
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.
Data Source
1. In the panel on the left, tap to expand Advanced. Then, choose Admin.
4. Choose the Startup Page that you want to appear when you log in to the Admin. The list
includes every page in the Admin menu structure.
Startup Page
Dashboard Reports
REPORT DESCRIPTION
Sales The Dashboard reports on Lifetime Sales, Revenue, Tax, Shipping,
and Quantity for the time period specified.
Orders The Orders tab at the top displays a chart of all orders during the
specified time period. Below the chart is the total revenue, tax,
shipping, and quantity ordered. The lifetime sales amount and the last
five orders are on the left.
Amounts The Amounts tab at the top displays a chart of all order amounts
during the specified time period. The average order amount and the
last five orders are on the left.
Search Terms The last five search terms, and top five search terms appear on the
left.
Products The Bestsellers tab shows the price and quantity ordered of your
best-selling products. The products that have been viewed the most
during the specified time period are listed on the Most Viewed
Products tab.
Customers The Customers tab at the bottom lists the customers who have
ordered the most during the specified range of time. The New
Customers tab lists all new customers who have registered for an
account during the time period. On the left, the Last Orders section
lists the most recent orders by customer.
Message Inbox
Your store receives messages from Magento on a regular basis. The messages might refer to
system updates, patches, new releases, scheduled maintenance or upcoming events, and are
rated by importance. The bell icon in the header indicates the number of unread messages in
your inbox.
Incoming Messages
Any message of critical importance appears in a pop-up window when you log into your store.
The notice continues to appear after each login until the message is either marked as read, or
removed.
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.
1. Tap the Notification icon in the header, and read the summary. Then, do one of the following:
l To delete the message, tap the delete icon to the right of the message.
l To remove the popup, but keep the message active, tap Close.
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.
l For more information, tap Read Details. The linked page opens in a new window.
All Notifications
l Mark the checkbox in the first column to select each message to be managed.
l Mark as Read
l Remove
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.
a. If your store Admin runs over a secure URL, 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.
Notifications
Global Search
The magnifying glass in the header of the Admin can be used to find any record in the
database. The results can include customers, products, orders, or any related attribute. For
example, if you enter a customer name, the results might include the customer record as well
as any orders that are associated with the name.
Search
To find a match:
1. In the header, tap the magnifying 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.
Grid Controls
Admin pages that manage data display a collection of records in a grid. The controls at the top
of each column can be used to sort the data. The current sort order is indicated by an ascending
or descending arrow in the column header. You can specify which columns appear in the grid,
and drag them into different positions. You can also save different column arrangements as
views that can be used later. The Action column lists operations that can be applied to an
individual record. In addition, date from the current view of most grids can be exported to a
CSV or XML file.
Orders Grid
1. Tap any column header. The arrow indicates the current order as either ascending or
descending.
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.
1. Tap Filters.
2. Complete as many filters as necessary to describe the record you want to find.
3. Tap Apply Filters.
Filter Controls
To export data:
Product data cannot be exported from the grid. To learn more, see Export.
2. On the Export ( ) menu in the upper-right corner, choose one of the following file formats:
l CSV
l Excel XML
Export Control
3. Tap Export.
4. Look for the downloaded file of exported data at the bottom of your browser window. Then,
open the file from the pop-up menu.
Grid Layout
The selection of columns and their order in the grid can be changed according to your
preference, and saved as a “view.” By default, only nine of twenty available columns are visible
in the grid.
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.
To move a column:
2. Enter a name for the view. Then, click the arrow ( ) to save all changes.
l To change the name of a view, tap the Edit ( ) icon. Then, update the name.
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.
The checkbox in the first column of the list identifies each record that is a target for the action.
The filter controls can be used to narrow the list to the records you want to target for the
action.
1. Mark the checkbox of each record that is a target for the action. Or, use one of the following
Actions to select a group of records:
2. If needed, set the filters at the top of each column to show only the records that you want to
include.
1. Set the Actions control to the operation that you want to apply.
The Update Attributes page lists all the available attributes, organized by group in the
panel on the left.
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.
Actions
ACTION DESCRIPTION
Select All Marks the checkbox of all records in the list.
Select All on This Page Marks the checkbox of records on the current page.
Deselect All on This Page Clears the checkbox of records on the current page.
Actions by Grid
MENU LIST ACTIONS
SALES
Orders Cancel
Hold
Unhold
Print Invoices
Print Packing Slips
Print Credit Memos
Print All
Print Shipping Labels
Move to Archive
PRODUCTS
Catalog Delete
Change Status
Update Attributes
CUSTOMERS
MARKETING
Communications
User Content
Reviews Delete
Update Status
CONTENT
Elements
Pages Delete
Disable
Enable
Edit
Blocks Delete
Edit
REPORTS
STORES
Settings
SYSTEM
Tools
Backups Delete
Other Settings
4. In the Admin Session Lifetime (seconds) field, enter the number of seconds that a session
remains active before it times out.
Security
General Configuration
Store Information
The Store Information section provides the basic information that appears on sales documents
and in other communications.
Store Information
a. Enter the Store Name that you want to use in all communications.
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.
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. To learn more, see: VAT ID Validation.
Locale Options
The locale determines the language, country, tax rate, and other settings that are used
throughout the store. The Locale Options determine the time zone and language used for each
store, and identify the days of the work week in your area.
Locale Options
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.)
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
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 In countries where the state field is not required, includes the State field as an
optional entry.
No In countries where the state field is not required, omits the State field.
Country Options
The Country Options identify the country where your business is located, and the countries
from which you accept payment.
Country Options
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.
Merchant Location
The Merchant Location setting is used to configure payment methods. If no value is entered,
the Default Country setting is used.
Merchant Location
3. Expand the Merchant Location section. Then, choose your Merchant Country.
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.
Currency Chooser
If multiple currencies are available, the currency chooser
appears in the header of the store.
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
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.
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.
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.
4. Repeat this process for each store email addresses that you plan to use.
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 RMA, RMA Authorization, RMA Admin Comments, and RMA Customer Comments
2. Starting with Order, expand the section for each message, and make sure that the correct
sender is selected.
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. A standard Magento
installation displays the default Contact Us form. After submitting the form, a thank you
message appears
It is important to understand that the default Contact Us form is rendered directly from code
rather than from a CMS page.
Contact Us Page
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
Contact Us
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.
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.
Contact Us Info
3. Scroll down to the Content field, and make any changes necessary.
l Use the editor toolbar to format the text, and add images and links.
a. Follow the standard instructions to create a new page, with the following settings:
a. Add any information that you want to include. The content that you enter will appear to
the left of the form.
a. If you want to align your content with the top of the form, enclose it in a <div> tag that
floats left as shown in the following example:
Example
b. Tap Show / Hide Editor to remove the toolbar. Then, paste the following code on a line
below the content that you entered in the last step.
“Contact Us”
{{block class="Magento\Contact\Block\ContactForm"
name="contactForm" template="Magento_Contact::form.phtml"}}
Your custom form now appears instead of the default form whenever the Contact Us link in the
footer is clicked. Make sure to test your content on a mobile device to ensure that it renders
correctly.
Storefront Branding
Logo in Header
The logo image resides in the following location on the server. Any image file with the name
“logo.gif” is used as the default theme logo.
If you don’t know the size of the logo, or any other image that is used in your theme, open the
page in a browser, right-click the image, and inspect the element.
In addition to the logo in the header, your logo also appears on email templates and on PDF
invoices and other sales documents. The logos used for email templates and invoices have
different size requirements, and must be uploaded separately. To learn more, see:
Communications.
Design Configuration
2. Find the store view that you want to configure, and in the Action column, click Edit.
Header
a. To upload a new logo, tap Upload. Then, choose the file from your computer.
c. In the Logo Image Alt field, enter the text that you want to appear when someone hovers
over the image.
JPG (JPEG) (Joint Photographics Expert Group) A compressed bitmap format that
is used by most digital cameras. The lossy compression causes
some data loss, which is sometimes noticeable as blurry spots in
text.
Adding a Favicon
Favicon is short for “favorite icon,” and refers to the little icon on the tab of each browser page.
Depending on the browser, the favicon also appears in address bar, just before the URL.
Favicons are generally 16 x 16 pixels or 32 x 32 pixels in size. Magento accepts ICO, PNG,
APNG, GIF, and JPG (JPEG) file types, although not all browsers support these formats. The
most widely-supported file format to use for a favicon is ICO. Other image file types can be
used, although the format might not be supported by all browsers. There are many free tools
available online that you can use to generate an ICO image or convert an exiting image to the
format.
Process Overview:
Step 1: Create a Favicon
Step 2: Upload the Favicon to Your Store
Step 3: Refresh the Cache
1. Create a 16 x 16 or 32 x 32 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.
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:
HTML Head
a. Tap Upload. Then, navigate to the favicon file that you prepared, and tap Open.
Favicon
b. If you want to delete the current favicon, tap Delete ( ) in the lower-left corner of the
image. Then, upload another.
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.”
4. To view the new favicon, return to your storefront and press F5 to refresh the browser.
JPG (JPEG) (Joint Photographics Expert Group) A compressed bitmap format that
is used by most digital cameras. The lossy compression causes
some data loss, which is sometimes noticeable as blurry spots in
text.
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
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
b. Enter the Welcome Text that you want to appear in the header of your store.
Header
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:
2. In the grid, find the store view that you want to configure. Then in the Action column, click
Edit, and do the following:
Design Configuration
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.
2. In the grid, find the store view that you want to configure. Then in the Action column, click
Edit.
4. Scroll down to the bottom, and set the Display Demo Store Notice to your preference.
HTML Head
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.
Scope
If your Magento installation has a hierarchy of websites, stores, or views, you can set the
context, or “scope” of a configuration setting to apply to a specific part of the installation. The
context of many database entities can also be assigned a specific scope to determine how it is
used in the store hierarchy. To learn more, see: Product Scope and Price Scope.
Some configuration settings such as postal code, have a [global] scope because the same value
is used throughout the system. The [website] scope applies to any stores below that level in the
hierarchy, including all stores and their views. Any item with the scope of [store view] can be
set differently for each store view, which is typically used to support multiple languages.
Unless the store is running in Single Store Mode, the scope of each configuration setting
appears in small text below the field label. If your installation includes multiple websites,
stores or views, you should always choose the Store View where the settings apply before
making any changes.
Scope Settings
SCOPE DESCRIPTION
Global System-wide settings and resources that are available throughout the
Magento installation.
Website Settings and resources that are limited to the current website. Each
website has a default store.
Store Settings and resources that are limited to the current store. Each
store has a default root category (main menu) and default store view.
Store View Setting and resources that are limited to the current store view.
Changing Scope
The Store View chooser in the upper-left corner of many Admin pages filters the view of the
page for a specific scope, and also sets the value of some entities that are used by Magento. It
lists each level in the hierarchy by name, and is used to change the scope to another level. Any
settings that represent the current scope are grayed out, so only those that represent the
current scope setting are available. The scope is initially set to “Default Config.” For Admin
users with restricted access, the list of available store views includes only those to which the
user has permission to access.
The checkbox to the right of many configuration settings can be used to either apply or override
the default setting, according to the current scope. The field value cannot be changed when the
checkbox is marked. To change the current value, first clear the checkbox, and then enter the
new value. You are prompted to confirm whenever you change scope. The checkbox label
changes according to the current scope, and always refers to the parent level which is one step
up in the hierarchy. Because the parent level is a container for all the items below that level,
the value from the parent level is inherited. unless it is overridden.
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.
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.
Store Hierarchy
LEVEL DESCRIPTION
Default Config The default system configuration.
Main Website The name of the website at the top of the hierarchy.
Main Website Store The name of the default store that is associated with the parent
website.
Default Store View The name of the default store view that is associated with the parent
store.
Stores Configuration Jumps to the Stores grid, and is the same as choosing Stores > All
Stores from the Admin sidebar.
Use Default The “Use Default” checkbox appears when the configuration scope is
set to “Main Website,” and refers to the default store that is assigned
to the website.
Use Website The “Use Website” checkbox appears when the configuration scope
set to a specific store view. When marked, it uses the setting from
the parent website that is associated with the store view. In this
case, the store level is skipped because it is understood to apply to
the default store that is associated with the website.
Catalog Scope
Magento uses the term “catalog” to refer to the product database as a whole. Access to catalog
data is determined by several factors, including the scope setting, the catalog configuration,
and the root category that is assigned to the store. The catalog includes products that are
enabled and available for sale, as well as those that are currently not offered for sale.
In sales, the term “catalog” usually refers to a curated selection of products that is available for
sale. For example, a store might have a “Spring Catalog” and a “Fall Catalog”.
Like the table of contents of a printed catalog, the main menu of your store — or “top
navigation” — organizes products by category to make it easy for customers to find what they
want. The main menu is based on a “root category,” which is a container for the menu that is
assigned to the store. Because the specific menu options are defined at the store view level,
each view can have a different main menu based on the same root category. Within each menu,
you can offer a curated selection of products that is suitable for the store.
Product Scope
For installations with multiple websites, stores, and views, the scope setting determines where
products are available for sale, and the product information that is available for each store
view. Initially, all products that you create are published to the default website, store, and store
view.
Multisite Installation
If you have only a single store with the default view, you can run your store in Single Store
Mode to hide the scope settings. However, if your store has multiple views, a scope indicator
appears below the name of each field.
l To edit product information for a specific view, use the Store View control in the upper-left
corner to choose the view. Additional controls become available for any field that can be
edited at the store view level.
l To define the scope of a product in a multisite installation, see the Product in Websites
section of product information.
The process of editing a product for a store view is like adding a layer of product information
that is specific to the view.
You can only edit or assign products for the site you have permissions for, not for all sites
where the product is assigned.
Although the Spanish store view is selected in the following example, the product information
still appears in the original language of the default store view. To translate the product
information, you must switch to the Spanish view, and translate the text fields — such as
product title, description, and the meta data. To learn more, see: Translating Products.
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.
4. In the upper-left corner, set the Store View chooser back to the default.
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.
Price Scope
The scope of the base currency that is used for product prices can be configured to apply at
either the global or website level. If applied at the global level, the same price is used
throughout the store hierarchy. If the price configuration is set to the website level, the same
product can be available at different prices in different stores. By default, the scope of product
pricing is global.
Different factors can affect the price of the same product in one location and not another. For
example, there might be additional costs to bring the product to market, and other
considerations that impact the price of products sold in a specific store. The following
illustration shows a multisite installation with the base currency set to the website level. In
each store, the same product has a different price.
Price Scope
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.
4. If necessary, clear the User system value checkbox. Then, set Share Customer Accounts to
one of the following:
Global Shares customer account information with every website and store in the
Magento installation.
Per Website Limits customer account information to the website where the account was
created.
GLOBAL
Admin All websites, stores, and store views in the installation are managed
from the same Admin.
Default Config The global default configuration settings are used through the store
hierarchy, unless they are overridden at a lower level.
Catalog The term “catalog” refers to the product database as a whole, and is
available throughout the installation.
Product Configurations Attributes that are used as configurable product options must have a
global scope.
WEBSITE
Currency Each website can be assigned a different base currency. The base
currency is used to process all transactions, although a different
display currency might appear to the customer, according to the
locale of the store view.
Products Individual products are assigned to the hierarchy at the website level.
The Products grid lists all products in the catalog, and the websites
where they are available.The Product in Websites setting identifies
each website where the product is available.
SCOPE DESCRIPTION
Product Prices Product prices can be configured to be applied at either a global or
website level.
Payment Methods Payment methods are configured at the website level, although the
title and instructions can be configured for each store view.
Checkout The checkout process takes place at the website level, although
some display options can be configured for each store view. All
stores associated with a website have the same checkout
configuration.
STORE
Root Category Each store can have a separate set of products and main menu that
is based on a “root” category and subcategories. Each catalog has a
root category that is assigned at the store level.
STORE VIEW
Subcategories The subcategories that make up the main menu (under the root) are
assigned at the store view level.
Locale Each store view can be assigned a different locale. The display
currency, units of measurement, and most of the Admin interface are
specific to the locale.
Display Currency A different display currency can be used for each store view,
although the transactions are processed at the website level using
the base currency.
2. Under General, scroll down to the bottom of the page, and expand the Single-Store Mode
section.
a. Tap the Cache Management link in the system message at the top of the page.
System Message
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 Global Data Protection Regulations and the cookie law, which is required in
some countries and considered to be a best practice in others. In addition, you will learn how to
customize and maintain a privacy policy for your store.
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.
Track and monitor all access to network resources and cardholder data.
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.
GDPR Compliance
The General Data Protection Regulation (GDPR) is legislation that regulates data protection
and privacy for all individuals in the European Union and the European Economic Area. The
legislation also applies to the export of personal data outside the EU. The GDPR was adopted
in April 2016, and became enforceable on 25 May, 2018. Business that are not based in the EU,
but engage in global commerce are required to comply with the regulation.
All organizations that process personal data must disclose the following:
Best Practices
Examine the current privacy policies for all of your Magento stores to ensure that they align
with GDPR requirements. .
Update your Google settings to ensure that its use of personal data follows GDPR
requirements.
Visit the Magento website to learn how Magento helps merchants prepare for GDPR
compliance.
For developers in need of technical information, including data flow diagrams and mapping,
see: Magento 2.3 GDPR compliance.
Privacy Policy
Your store includes a sample privacy policy that must be updated with your own information.
Your privacy policy should describe the type of information that your company collects, and
how it is used. It should also list the filenames of cookies that are placed on the computers of
people who visit your store. Any additional cookies that are associated with third-party
extensions and add-ons should be included in the list.
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: Using the Editor.
Content
If you change the URL key of the privacy policy page, you must also create a custom URL rewrite to
redirect traffic to the new URL key. Otherwise, the link in the footer will return “404 Page Not
Found.”
If you have modified the default Google settings to comply with the General Data Protection
Regulation, it is no longer necessary to obtain user consent for the use of Google Analytics cookies.
Your privacy policy should include the name of your store and contact information, and
explain the purpose of each cookie that is used by your store. To learn more, see: Cookie
Reference.
If you change the URL key of the privacy policy, you must also create a custom URL rewrite to
redirect traffic to the new URL key. Otherwise, the link in the Cookie Restriction Mode message will
return “404 Page Not Found.”
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:
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.”
4. When prompted to update the cache, click the Cache Management link in the system message.
Then, refresh each invalid cache.
Update your privacy policy as needed to describe the information that your company collects,
and how it is used.
Cookie Reference
The default Magento cookies are classified as Exempt / Non-Exempt to help merchants meet
GDPR requirements. Merchants should use this information as a guide, and consult with legal
advisors to update their Privacy and Cookie Policies as part of a comprehensive
GDPR compliance strategy.
Some of these cookies may provide configuration options, including enable/disable, as needed.
add_to_cart
Used by Google Tag Manager. Captures the product SKU, name, price and quantity removed
from the cart, and makes the information available for future integration by third-party scripts.
guest-view
Stores the Order ID that guest shoppers use to retrieve their order status. Guest orders view.
Used in "Orders and Returns" widgets.
l Is Secure? No
l Module: Magento_Sales
login_redirect
Preserves the destination page the customer was navigating to before being directed to log in.
Used in mini cart for logged in customers if Stores > Settings > Configuration > Sales >
Checkout > Shopping Cart Sidebar > Display Shopping Cart Sidebar is set to "Yes".
l Is Secure? No
l HTTP Only: No
l Module: Magento_Customer
mage-banners-cache-storage
Stores banner content locally to improve performance.
mage-messages
Tracks error messages and other notifications that are shown to the user, such as the cookie
consent message, and various error messages. The message is deleted from the cookie after it is
shown to the shopper.
l Is Secure? No
l HTTP Only: No
l Expiration Policy: Duration 1 year. Cleared on frontend when the message is displayed to
the user.
l Module: Magento_Theme
mage-translation-storage(local storage)
Stores translated content when requested by the shopper. Used when Translation Strategy is
configured as "Dictionary (Translation on Storefront side)".
l Is Secure? No
l HTTP Only: No
l Module: Magento_Translation
l Is Secure? No
l HTTP Only: No
l Module: Magento_Translation
l Is Secure? No
l HTTP Only: No
l Module: Magento_Catalog
l Is Secure? No
l HTTP Only: No
l Module: Magento_Catalog
l Is Secure? No
l HTTP Only: No
l Module: Magento_Catalog
l Is Secure? No
l HTTP Only: No
l Module: Magento_Catalog
l Is Secure? No
l HTTP Only: No
l Module: Magento_Catalog
remove_from_cart
Used by Google Tag Manager. Captures the product SKU, name, price and quantity added to
the cart, and makes the information available for future integration by third-party scripts.
stf
Records the time messages are sent by the SendFriend (Email a Friend) module.
l Is Secure? Yes
l Module: Magento_SendFriend
X-Magento-Vary
Configuration setting that improves performance when using Varnish static content caching.
l Is Secure? Yes
l Module: Magento_PageCache
amz_auth_err
Used if "Enable Login with Amazon" is enabled. Value “1’ indicates an authorization error.
l Is Secure? No
l HTTP Only: No
amz_auth_logout
Used if "Enable Login with Amazon" is enabled. Value “1” indicates that the user should be
logged out.
l Is Secure? No
l HTTP Only: No
form_key
A security measure that appends a random string to all form submissions to protect the data
from Cross-Site Request Forgery (CSRF).
l Is Secure? No
l HTTP Only: No
l Expiration Policy:
l PHP: Based on PHP setting session.cookie_lifetime
l JS: Session
mage-cache-sessid
The value of this cookie triggers the cleanup of local cache storage. When the cookie is removed
by the backend application, the Admin cleans up local storage, and sets the cookie value to
“true.”
l Is Secure? No
l HTTP Only: No
l Module: Magento_Customer
mage-cache-storage
Local storage of visitor-specific content that enables ecommerce functions.
l Is Secure? No
l HTTP Only: No
l Is Secure? No
l HTTP Only: No
l Is Secure? No
l HTTP Only: No
l Module: Magento_Customer
persistent_shopping_cart
Stores the key (ID) of persistent cart to make it possible to restore the cart for an anonymous
shopper.
l Is Secure? Yes
l Expiration Policy: Based on configuration Persistent Shopping Cart > General Options >
Persistence Lifetime (seconds)
l Module: Magento_Persistent
private_content_version
Appends a random, unique number and time to pages with customer content to prevent them
from being cached on the server.
For the HTTP Only Yes (based on request) means that the cookie Secure if set during HTTPS
request, and unsecure if set during HTTP request.
l HTTP Only:
l PHP: 1 year / 315360000s (10yr)
l JS: 1 day
l Expiration Policy: Based on configuration Persistent Shopping Cart > General Options >
Persistence Lifetime (seconds)
section_data_ids
Stores customer-specific information related to shopper-initiated actions such as display wish
list, checkout information, etc.
l Is Secure? No
l HTTP Only: No
l Module: Magento_Customer
store
Tracks the specific store view / locale selected by the shopper.
l Is Secure? No
l Module: Magento_Store
l Is Secure? No
l HTTP Only: No
l Module: Magento_Banner
l AMP_TOKEN: Contains a token that can be used to retrieve a Client ID from AMP Client ID
service. Other possible values include opt-out, inflight request or an error retrieving a Client
ID from AMP Client ID service.
Accessibility
Some visitors to your site rely on keyboard controls for navigation —rather than a mouse —
while others might use touch or voice commands. Although keyboard navigation controls vary
by browser and platform, the Tab key is commonly used to move the focus through the fields,
links, and buttons on a page. To learn more, see Keyboard Shortcuts.
Keyboard Navigation
ENVIRONMENT COMMAND
Windows Next Page Alt + Right
Close Esc
143
Contents Bundle Items
Managing Pricing
Catalog Menu
Advanced Pricing
Catalog URLs
Group Pricing
Products Grid Special Pricing
Tier Pricing
Creating Products
Minimum Advertised Price
Product Workspace
Default Field Values Managing Inventory
Scheduled Changes Stock Options
Product Types Product Alerts
Simple Product
Images and Videos
Configurable Product
Uploading Product Images
Grouped Product
Adding Product Video
Virtual Product
Media Gallery
Bundle Product
Placeholders
Downloadable Product
Watermarks
Download Options
Swatches
Gift Cards
Gift Card Workflow Categories
Creating a Gift Card Best Practices
Gift Card Accounts Creating Categories
Configuring Gift Card Accounts Root Categories
Hidden Categories
Product Settings
Scheduled Changes
Advanced Settings
Content Settings
Other Settings
Display Settings
Content
Search Engine Optimization
Configurations
Products in Category
Product Reviews
Sorting Category Products
Images and Videos
Design Settings
Search Engine Optimization
Category Permissions
Related Products, Up-sells, and Cross-sells
Customizable Options Using Product Attributes
Product in Websites Best Practices
Design Adding an Attribute
Autosettings Attribute Input Types
Gift Options
Using a Flat Catalog
Downloadable Information
Grouped Products
144
CHAPTER 10:
Catalog Menu
The Catalog Menu provides easy access to product creation, category and inventory
management tools.
Catalog Menu
Menu Options
Products
Create new products of every type, and manage your
inventory.
Categories
Create the category structure that is the foundation of
your store’s navigation.
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 search-
engine friendly format, or one that references products and categories by ID. Search-engine
friendly URLs include words that people might use to look for a product, and require Web
Server Rewrites to be enabled. Files with static URLs are commonly used for product and
category pages, content pages, and theme assets.
http://mystore.com/antonia-racer-tank.html
URL Components
URL Key
The URL key is the part of a static URL that describes the product or category. When you
create a product or category, an initial URL key is automatically generated, based on the
name. To change the URL key, see the Search Engine Optimization section of the product
information.
The URL key should consist of lowercase characters with hyphens to separate words. A well-
designed, “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.
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.
http://mystore.com/women/tops-women/hoodies-and-sweatshirts-women/helena-
hooded-fleece.html
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.
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.
5. When prompted, click the Cache Management link in the system message, and refresh the
invalid cache.
Refresh Cache
The Products grid lists all products in the catalog, indicates the website(s) where they are
available, and if they are currently enabled for sale.
You can browse through the list page by page, or search for specific products. Use the standard
controls to sort and filter the list, and apply actions to selected products.
Products Grid
Workspace Controls
CONTROL DESCRIPTION
Add Product Initiates the process to create a new simple product. To choose a
specific product type, click the down arrow. Options:
Simple Product
Configurable Product
Grouped Product
Virtual Product
Bundle Product
Downloadable Product
Gift Card
Actions Lists all actions that can be applied to selected products in the list. To
apply an action to a product or group of products, mark the checkbox
in the first column of each product. Options:
Delete
Change Status
Update Attributes
[Default] View Indicates the current grid column layout. If there are saved grid
column views, you can choose another.
Columns Lists all actions that can be applied to selected products in the list. To
apply an action to a product or group of products, mark the checkbox
in the first column of each product. Product list actions include:
Delete
Change Status
Update Attributes
Use the Columns control to customize the selection of columns in
the grid.
Actions Can be used to select multiple records as the target of action. The
checkbox is marked in the first column of each selected record.
Options: Select/Deselect All
Edit Opens the product in edit mode. You can accomplish the same thing
by clicking anywhere on the row.
Default Columns
COLUMN DESCRIPTION
(Checkbox) Selects multiple records to be subject to an action. The checkbox in
the first column of each selected record is marked . Options:
Select All Selects all records found that match the current filter
settings.
Select All on Selects only the records found on the current page
This Page that match the filter settings.
Attribute Set The name of the attribute set that is used as a template for the
product.
SKU The unique Stock Keeping Unit that is assigned to the product.
If you are just starting out, you can create a few sample products to experiment with each
product type. For a deeper understanding, make sure to read about catalog navigation, how to
set up categories and attributes, and the catalog URL options that are available to you.
After you learn the basics, the most efficient way to add a large number of products to the
catalog is to import them from a CSV file.
Product Catalog
Product Workspace
The product workspace is basically the same for all product types, although the selection of
fields changes depending on the attribute set that is used. The product attributes are at the top
of the form, followed by expandable sections of product information. When a new product is
saved for the first time, the Store View chooser appears in the upper-left of the form.
Product Workspace
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.
Attribute Set
The name of the attribute set appears in the upper-left corner, and determines the fields that
appear in the product record. To choose a different attribute set, click the down arrow next to
the default attribute set name.
Attribute Sets
Expand/Collapse
To expand or collapse a section, tap either the expand or collapse button to the right.
Save Menu
The Save menu includes several options that let you save and continue, save and create a new
product, save and duplicate the product, or save and close.
Save Menu
Save Menu
COMMAND DESCRIPTION
Save Save the current product, and continue working.
Save & New Save and close the current product, and begin a new product, based on the
same product type and template.
Save & Duplicate Save and close the current product, and open a new duplicate copy.
Save & Close Save the current product and return to the Inventory workspace.
FIELD DESCRIPTION
SKU Based on product Name.
The placeholders that represent the value of another field are enclosed in double-curly braces.
Any attribute code that is included in the product attribute set can be used as a placeholder.
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.
Common Placeholders
PLACEHOLDER
{{color}}
{{country_of_manufacture}}
{{description}}
{{gender}}
{{material}}
{{name}}
{{short_description}}
{{size}}
{{sku}}
Scheduled Changes
Product updates can be applied on schedule, and grouped with other content changes. You can
create a new campaign based on scheduled changes to the product, or apply the changes to an
existing campaign. To learn more, see: Content Staging.
Scheduled Changes
Product Types
Simple Product
Configurable Product
Grouped Product
Virtual Product
Bundle Product
Downloadable Product
Gift Card
There are three kinds of gift cards: virtual gift cards which
are sent by email, physical gift cards which are shipped
to the recipient, and combined gift cards which are a
combination of the two. Each has a unique code, that is
redeemed during checkout. Gift cards can also be
included in a grouped product.
Simple Product
One of the keys to harnessing the power of product types is learning when to use a simple,
standalone product. A simple product 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 instructions take you through the process of creating a simple product using a
product template, required fields, and basic settings. Each required field is marked with a red
asterisk (*). When you finish the basics, you can complete the advanced settings and other
settings as needed.
Simple Product
Process Overview:
Step 1: Choose the Product Type
Step 2: Choose the Attribute Set
Step 3: Complete the Required Settings
Step 4: Complete the Basic Settings
Step 5: Complete the Product Information
Step 6: Publish the Product
2. In the upper-right corner on the Add Product ( ) menu, choose Simple Product.
To choose the attribute set that is used as a template for the product, do one of the following:
l In the list, choose the attribute set that you want to use.
2. Accept the default SKU that is based on the product name, or enter another.
4. Because the product is not yet ready to publish, set the Enable Product switch to the “No”
position.
When the product is saved, the Store View chooser appears in the upper-left corner.
l None
l Taxable Goods
Inventory Management: If you enable Inventory Management, Single Source merchants set the
quantity in this section. Multi Source merchants add sources and quantities in the Sources section.
See the following Assign Sources and Quantities (Inventory Management) section.
5. To assign Categories to the product, tap the Select… box. Then, do either of the following:
b. Enter the Category Name and choose the Parent Category to determine its position in the
menu structure.
6. To feature the product in the list of new products, mark the Set Product as New checkbox.
Product Details
There might be additional individual attributes that describe the product. The selection varies
attribute set, and you can complete them later.
For Multi Source merchants using Inventory Management, scroll down to the Sources section
and assign sources and quantities:
1. To add a source, tap Assign Sources. The Assign Sources page displays.
2. Browse or search for a source you want to add. Select the checkbox next to the source(s) you
want to add for the product.
Custom Notify Quantity Clear the Notify Quantity Use Default checkbox and
enter an amount in Notify Quantity.
Default Notify Quantity Select the Notify Quantity Use Default checkbox.
Magento checks and uses the setting in Advanced
Inventory or global Store configuration.
Scroll down and complete the information in the following sections as needed:
l Content
l Customizable Options
l Products in Websites
l Design
l Gift Options
1. If you are ready to publish the product in the catalog, set the Enable Product switch to the
“Yes” position.
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
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.
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.
The following instructions take you through the process of creating a configurable product
using a product template, required fields, and basic settings. Each required field is marked with
a red asterisk (*). When you finish the basics, you can complete the advanced settings and
other settings as needed.
Configurable Product
Before you begin, prepare an attribute set that includes an attribute that is set to one of the
allowable input types for each product variation. For example, the attribute set might include
dropdown attributes for color and size.
The properties of each attribute that is used for a configurable product variation must have the
following settings:
Catalog Input Type for The input type of any attribute that is used for a product variation
Store Owner must be one of the following:
Dropdown
Visual Swatch
Text Swatch
Process Overview:
Part I: Create Configurable Product
Step 1: Choose the Product Type
Step 3: Complete the Required Settings
Step 4: Complete the Basic Settings
Step 5: Save and Continue
2. In the upper-right corner on the Add Product ( ) menu, choose Configurable Product.
The attribute set determines the selection of fields that are used in the product. The attribute
set that is used in the following example has drop-down attributes for color and size. The name
of the attribute set is indicated at the top of the page, and is initially set to “Default”.
1. To choose the attribute set for the product, click the field at the top of the page and do one of
the following:
l In the list, choose the attribute set that you want to use.
2. If you need to add an additional attribute to the attribute set, tap Add Attribute. Then, follow
the instruction in Adding an Attribute to a Product.
Choose Template
2. Accept the default SKU that is based on the product name, or enter another.
4. Because the product is not yet ready to publish, set Enable Product to the “No” ( )
position.
When the product is saved, the Store View chooser appears in the upper-left corner.
l None
l Taxable Goods
2. The Quantity is determined by the product variations, so you can leave it blank for now.
3. To feature the product in the list of new products, select the Set Product as New checkbox.
4. To assign Categories to the product, tap the Select… box. Then, do either of the following:
b. Enter the Category Name and choose the Parent Category to determine its position in the
menu structure.
5. To feature the product in the list of new products, mark the Set Product as New checkbox.
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.
The progress bar at the top of the page shows where you are in the process, and guides you
through each step.
Progress Bar
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.
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.
1. For each attribute, mark the checkbox of the values that apply to the product.
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.
2. Browse to each image that you want to include in the product gallery, or drag them to the
box.
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.
3. Enter the price for each attribute value. In this example, the XL size costs more.
2. To add a source, tap Assign Sources. The Assign Sources page displays.
3. Browse or search for a source you want to add. Select the checkbox next to the source(s)
you want to add for the product.
Summary
The current product variations appear at the bottom of the Configuration section.
Current Configurations
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.
Scroll down and complete the information in the following sections as needed:
l Content
l Customizable Options
l Products in Websites
l Design
l Gift Options
1. If you are ready to publish the product in the catalog, set Enable Product to the “Yes” ( )
position.
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
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 the Shopping Cart
section.
THINGS TO REMEMBER
A configurable product allows the shopper to choose options from drop-down, multiple
select, visual swatch and text swatch input types. Each option is actually a separate,
simple product.
The attributes that are used for product variations must have a global scope and the
customer must be required to choose a value. The product variation attributes must be
included in the attribute set that is used as a template for the configurable product.
The attribute set that is used as a template for a configurable product must include the
attribute(s) that contain the values that are needed for each product variation.
The thumbnail image in the shopping cart can be set to display the image from the
configurable product record, or from the product variation.
Grouped Product
A grouped product consists 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. Presenting a
grouped product can create an incentive for customers to purchase additional items. A grouped
product provides an easy way to offer variations of a product, and list them all on the same
page.
For example, you might sell open stock flatware, and list every type of utensil that is used in a
formal place setting. Some might order multiple salad forks, fish forks, dinner forks, dinner
knives, fish knives, butter knives, soup spoons, and dessert spoons. Other customers might
order a simple fork, knife, and spoon. Customers can order as many of each item as they want.
Although they are presented as a group, each product in the group is purchased as a separate
item. In the shopping cart, each item and the quantity purchased appears a separate line item.
The following instructions take you through the process of creating a grouped product using a
product template, required fields, and basic settings. Each required field is marked with a red
asterisk (*). When you finish the basics, you can complete the advanced settings and other
settings as needed.
Grouped Product
Process Overview:
Step 1: Choose the Product Type
Step 2: Choose the Attribute Set
Step 3: Complete the Required Settings
Step 4: Complete the Basic Settings
Step 5: Add Products to the Group
Step 6: Publish the Product
Step 7: Configure the Cart Thumbnails (Optional)
2. In the upper-right corner on the Add Product ( ) menu, choose Grouped Product.
To choose the attribute set that is used as a template for the product, do one of the following:
l In the list, choose the attribute set that you want to use.
Choose Template
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.
When the product is saved, the Store View chooser appears in the upper-left corner.
2. To assign Categories to the product, tap the Select… box. Then, do either of the following:
b. Enter the Category Name and choose the Parent Category to determine its position in the
menu structure.
4. To feature the product in the list of new products, choose the Set Product as New From and
To dates on the calendar.
There might be additional individual attributes that describe the product. The selection varies
attribute set, and you can complete them later.
1. Scroll down to the Grouped Products section. Then, tap Add Products to Group .
Grouped Products
2. If necessary, use the filters to find the products that you want to include in the group.
3. In the list, mark the checkbox of each item that you want to include in the group.
For Multi Source merchants with Inventory Management, the grid includes a Quantity per
Source column with each assigned source and inventory stock amount.
Products in Group
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 Customizable Options
l Products in Websites
l Design
l Gift Options
1. If you are ready to publish the product in the catalog, set the Enable Product switch to the
“Yes” ( ) position.
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
If you have a different image for each product in the group, you can set the configuration to
use the correct image for the shopping cart thumbnail.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
Shopping Cart
THINGS TO REMEMBER
A grouped product is essentially a collection of simple associated products.
Each item purchased appears individually in the shopping cart, rather than as part of the
group.
The thumbnail image in the shopping cart can be set to display the image from the grouped
parent product, or associated product.
Virtual Product
Virtual products — or digital goods — represent non-tangible items such as memberships,
services, warranties, or subscriptions and digital downloads of books, music, videos, or other
products. Virtual products can be sold individually, or included as part of the following
product types:
l Grouped Product
l Bundle Product
Aside from the absence of the Weight field, the process of creating a virtual product and a
simple product is the same. The following instructions take you through the process of creating
a virtual product using a product template , required fields, and basic settings. When you
finish the basics, you can complete the advanced settings and other settings as needed.
PayPal has deprecated support for the sale of digital goods through PayPal Express Checkout, and
recommends that you use either PayPal Payments Standard or any other PayPal payment gateway
to process any order that includes virtual products.
Virtual Product
Process Overview:
Step 1: Choose the Product Type
Step 2: Choose the Attribute Set
Step 3: Complete the Required Settings
Step 4: Complete the Basic Settings
Step 5: Complete the Product Information
Step 6: Publish the Product
2. In the upper-right corner on the Add Product ( ) menu, choose Virtual Product.
To choose the attribute set that is used as a template for the product, do one of the following:
l In the list, choose the attribute set that you want to use.
2. Accept the default SKU that is based on the product name, or enter another.
4. Because the product is not yet ready to publish, set the Enable Product switch to the “No” (
) position.
When the product is saved, the Store View chooser appears in the upper-left corner.
l None
l Taxable Goods
2. Enter the Quantity of the product that is currently in stock. Then, do the following:
Note that the Weight field is not used, because a virtual product is not shipped.
For Multi Source merchants using Inventory Management, scroll down to the Sources section
and assign sources and quantities:
1. To add a source, tap Assign Sources. The Assign Sources page displays.
2. Browse or search for a source you want to add. Select the checkbox next to the source(s) you
want to add for the product.
Custom Notify Quantity Clear the Notify Quantity Use Default checkbox and
enter an amount in Notify Quantity.
Default Notify Quantity Select the Notify Quantity Use Default checkbox.
Magento checks and uses the setting in Advanced
Inventory or global Store configuration.
5. To assign Categories to the product, tap the Select… box. Then, do either of the following:
b. Enter the Category Name and choose the Parent Category to determine its position in the
menu structure.
There might be additional individual attributes that describe the product. The selection varies
attribute set, and you can complete them later.
l Content
l Customizable Options
l Products in Websites
l Design
l Gift Options
1. If you are ready to publish the product in the catalog, set the Enable Product switch to the
“Yes” ( ) position.
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
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.
Bundle Product
A bundle is a “build your own,” customizable product. Each item in a bundle can be based on
one of the following product types:
l Simple Product
l Virtual Product
Bundle Product
Minimum Advertised Price (MAP) is not available for Bundle products with dynamic pricing.
If Instant Purchase is available, the Instant Purchase button appears below the Add to Cart
button for each item in the bundle.
Customize Bundle
The following instructions take you through the process of creating a bundle product using a
product template, required fields, and basic settings. Each required field is marked with a red
asterisk (*). When you finish the basics, you can complete the advanced settings and other
settings as needed.
Process Overview:
Step 1: Choose the Product Type
Step 2: Choose the Attribute Set
Step 3: Complete the Required Settings
Step 4: Complete the Basic Settings
Step 5: Add the Bundle Items
Step 6: Complete the Product Information
Step 7: Publish the Product
2. In the upper-right corner on the Add Product ( ) menu, choose Bundle Product.
To choose the attribute set that is used as a template for the product, do one of the following:
l In the list, choose the attribute set that you want to use.
Choose Template
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.
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.” ( ) position.
Then, enter the Price that you want to charge for the bundle.
4. Because the product is not yet ready to publish, set the Enable Product switch to the “No” (
) position.
When the product is saved, the Store View chooser appears in the upper-left corner.
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.
l The Quantity is not available because the value is determined for each bundle item.
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.” ( ) position.
Then, enter the Weight of the bundle.
Dynamic Weight
4. To feature the product in the list of new products, mark the Set Product as New checkbox.
6. To assign Categories to the product, tap the Select… box. Then, do either of the following:
b. Enter the Category Name and choose the Parent Category to determine its position in the
menu structure.
Bundle Details
There might be additional attributes that describe the product. The selection varies attribute
set, and you can complete them later.
1. Scroll down to the Bundle Items section. Then, set Ship Bundle Items to one of the following:
l Separately
l Together
Bundle Items
l Drop-down
l Radio buttons
l Checkbox
l Multiple Select
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 list filters and pagination
controls to find the products you need.
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.
The quantity can be a preset or user-defined value. However, do not assign the User Defined
property to checkbox or multiple-select input types.
By default, the Default Quantity that is included in a bundle item cannot be changed by
the customer. However, the customer can enter the quantity of the item that is to be
included in the bundle.
For example, if the Default Quantity of the Sprite Status Ball is set to 2, and the customer
orders 4 of that bundle option, the total number of total balls purchased is 8.
Item Detail
3. Repeat these steps for each item you want to add to the bundle.
4. To remove any item from the bundle, tap the Delete ( ) icon.
Scroll down and complete the information in the following sections as needed:
l Content
l Customizable Options
l Products in Websites
l Design
l Gift Options
1. If you are ready to publish the product in the catalog, set the Enable Product switch to the
“Yes” ( ) position.
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
Input Controls
CONTROL DESCRIPTION
Drop-down Displays a drop-down list of options with the product name and price.
Only one item can be selected.
Radio Buttons Displays a radio button for each option, followed by the product name
and price. Only one item can be selected.
Checkbox Displays a checkbox for each option, followed by the product name
and price. Multiple items can be selected.
Multiple Select Displays a list of options with the product name and price. To select
multiple items, hold down the Ctrl (or Option) key, and click each
item.
Field Descriptions
FIELD DESCRIPTION
SKU Determines if each item is assigned a variable, dynamic SKU, or if a
fixed SKU is used for the bundle. Options include: Fixed / Dynamic.
Price View Determines if the product price is shown as a range, from the least
expensive to the most expensive (Price Range), or with the least
expensive shown (As Low As). Options include: Price Range / As
Low As.
THINGS TO REMEMBER
Customers can “build their own” bundle product.
The Price View can be set to a price range or to “As Low As.”
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.
Downloadable Product
A downloadable product can be anything that you can deliver as a file, such as an eBook,
music, video, software application, or update. You can offer an album for sale, and sell each
song individually. You can also use a downloadable product to deliver an electronic version of
your product catalog.
Because the actual download doesn’t become available until after the purchase, you can provide
samples, such as an excerpt from a book, a clip from an audio file, or a trailer from a video that
the customer can try before purchasing the product. The files that you make available for
download can be either uploaded to your server, or from a different server.
Downloadable Product
Downloadable products can be configured to require that the customer log in to an account to
receive the link, or can be sent by email and shared with others. The status of the order before
the download becomes available, default values, and other delivery options are set in the
configuration. To learn more, see: Configuring Download Options.
The following instructions take you through the process of creating a downloadable product
using a product template, required fields, and basic settings. Each required field is marked with
a red asterisk (*). When you finish the basics, you can complete the advanced settings and
other settings 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.
Process Overview:
Step 1: Choose the Product Type
Step 2: Choose the Attribute Set
Step 3: Complete the Required Settings
Step 4: Complete the Basic Settings
Step 5: Complete the Downloadable Information
Step 6: Complete the Product Information
Step 7: Publish the Product
2. In the upper-right corner on the Add Product ( ) menu, choose Downloadable Product.
The sample data includes an attribute set called “Downloadable” that has special fields for
downloadable products. You can use an existing template, or create another before the product
is saved.
To choose the attribute set that is used as a template for the product, do one of the following:
2. Accept the default SKU that is based on the product name, or enter another.
4. Because the product is not yet ready to publish, set the Enable Product switch to the “No” (
) position.
When the product is saved, the Store View chooser appears in the upper-left corner.
l None
l Taxable Goods
2. Enter the Quantity of the product that is currently in stock. For Multi Source merchants with
Inventory Management, see the expanded instructions.
l The Weight field is not used, because downloadable products are not shipped.
For Multi Source merchants using Inventory Management, scroll down to the Sources section
and assign sources and quantities:
1. To add a source, tap Assign Sources. The Assign Sources page displays.
2. Browse or search for a source you want to add. Select the checkbox next to the source(s) you
want to add for the product.
Custom Notify Quantity Clear the Notify Quantity Use Default checkbox and
enter an amount in Notify Quantity.
Default Notify Quantity Select the Notify Quantity Use Default checkbox.
Magento checks and uses the setting in Advanced
Inventory or global Store configuration.
6. To feature the product in the list of new products, mark the Set Product as New checkbox.
7. To assign Categories to the product, tap the Select… box. Then, do either of the following:
b. Enter the Category Name and choose the Parent Category to determine its position in the
menu structure.
l Download
l DVD
Product Details
There might be additional attributes that describe the product. The selection varies attribute
set, and you can complete them later.
1. Scroll down to Downloadable Information, and expand the section. Then, mark the Is this
downloadable product? checkbox.
The Downloadable Information section has two parts. The first part describes each download
link, and the second part describes each sample file. The default value for many of these
options can be set in the configuration.
Downloadable Information
1. In the Links section, enter the Title that you want to use as a heading for the download
links.
b. For both File and Sample files, choose one of the following methods of distribution
for the downloads:
Upload File To upload the the distribution file to the server, choose
“Upload File.” Then, browse to the file, and select it for
upload.
Yes Sends the link by email, which customers can share with
others.
Use Config Uses the method that is specified in the Dowloadable Product
Options configuration.
Link Detail
4. To add another link, tap Add Link. Then, repeat these steps.
1. In the Samples section, enter the Title that you want to use as a heading for the samples.
Samples
3. Complete the link detail as follows:
Upload File To upload the the sample distribution file to the server, choose
“Upload File.” Then, browse to the file, and select it for
upload.
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.
Scroll down and complete the information in the following sections as needed:
l Content
l Customizable Options
l Products in Websites
l Design
l Gift Options
1. If you are ready to publish the product in the catalog, set the Enable Product switch to the
“Yes” ( ) position.
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
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.
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.
No 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.
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:
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
Items to “Yes.”
Gift Cards
There are three kinds of gift card products: virtual gift cards sent by email, physical gift cards,
which can be shipped to the recipient, and a combination of the two. Each gift card has a
unique code, which can be redeemed by only one customer during checkout. A code pool must
be established before gift cards can be sold.
Virtual
A virtual gift card is sent to the recipient by email. The
order requires an email address for the recipient. A
shipping address is not necessary.
Physical
A physical gift card is shipped to recipient’s address,
which is required during the purchase of the gift card.
Combined
The gift card is shipped and emailed to the recipient. The
recipient’s email and shipping address is required to
purchase the gift card.
The gift card code(s) applied to an order can be viewed by opening the order in the Admin,
which makes it possible for you to retrieve the code to place it on a physical gift card, if
necessary. If a gift card order is canceled or refunded, you must manually cancel the associated
gift card account. You can either delete the account entirely, or deactivate it.
Scenario
For example, a customer shopping in the demo Luma store can purchase either a virtual or
physical gift card.
Customer determines the gift card value. The customer determines the value of the
gift card from the product page. Depending on the configuration, there is either a fixed
price field, a list of price options, or both. All amounts appear in the currency that is used
in the store.
Customer completes the gift card information. For a physical gift card, the customer
enters the Sender Name and Recipient Name. For virtual or combined gift cards, the
customer also enters the Sender Email and Recipient Email. If the customer is logged in,
the Sender Name (and Sender Email, if applicable) is entered automatically from their
account. Depending on the configuration, the customer might also enter a message to
the recipient.
Customer completes checkout. The gift card appears as a line item in the cart with
detail that shows the name of the sender and recipient, and message, if applicable. The
amount associated with the gift card is converted to the base currency of the store when
it is added to the cart.
Customer receives confirmation of the order. The gift card purchaser can click the
link in the confirmation to track the order from their account dashboard.
Recipient receives the gift card. For virtual or combined gift cards, the recipient
receives an email with the gift card code, name of the sender, and message, if
applicable. If multiple gift cards are purchased in a single order, and the type is either
virtual or combined, all corresponding gift card codes are sent to the recipient in a single
email.
Physical gift cards can be shipped directly to the recipient, or to the customer, who can
then personally deliver the gift card to the recipient.
Recipient applies gift card to purchase. The gift card purchases an item in your store,
and applies the gift card code during checkout. Each time a gift card is applied during
checkout, the amount appears in the order totals block, and is subtracted from the grand
total. The full balance of each gift card is subtracted from the shopping cart total.
If multiple gift cards are used to pay for a purchaes, the amounts are applied in ascending
order, starting with the card with the smallest remaining balance, until the customer runs
out of cards, or until the grand total is zero. When the grand total reaches zero, the last
gift card account applied to the cart receives a partial deduction. Any cards that have not
been applied to the cart do not receive a deduction. The amounts are deducted from the
gift card accounts only after the order is placed.
Process Overview:
Step 1: Choose the Product Type
Step 2: Choose the Attribute Set
Step 3: Complete the Required Settings
Step 4: Complete the Basic Settings
Step 5: Complete the Gift Card Information
Step 6: Complete the Product Information
Step 7: Publish the Product
2. In the upper-right corner on the Add Product ( ) menu, choose Gift Card.
You can use the default “Gift Card” attribute set, or choose another. To choose the attribute set
that is used as a template for the product, do one of the following:
l In the list, choose the attribute set that you want to use.
1. Enter a Product Name for the gift card. You might also indicate the type of gift card in the
name. For example, “Luma Virtual Gift Card.”
2. Enter a SKU for the product. By default, the Product Name is used as the default SKU.
Physical Physical gift cards can be mass produced in advance and embossed with
unique codes.
Combined A combined gift card has the characteristics of both a virtual and
physical gift card.
1. To offer the customer a choice of fixed amounts, tap Add Amount. Then, enter the first fixed
value of the card as a decimal. Repeat this step to enter the selection of fixed amounts.
2. To give customers the ability to set the value of the gift card, do the following:
b. To define the range of minimum and maximum acceptable values, enter the Open
Amount From and To values.
You can create gift cards with fixed pricing, open amount pricing, or both.
2. If the gift card that is to be shipped, enter the Weight of the package.
4. There might be additional individual attributes that describe the product. The selection varies
attribute set, and you can complete them later.
The default settings in this section are determined by the system configuration.
2. Clear the Use Config Settings checkbox of any of the following fields that you want to change:
Treat Balance as Determines if the gift card holder can redeem the balance as store credit.
Store Credit
Lifetime (days) Determines the number of days after purchase until the gift card expires.
If you do not want to set a limit for the lifetime of the card, leave this
field blank.
Allow Message Determines if the purchaser of the gift card can enter a message for to
the recipient. A gift message can be included for both virtual (emailed)
and physical (shipped) gift cards.
Email Template Determines the email template that is used for the notification sent to
the recipient of a gift card.
l Customizable Options
l Products in Websites
l Design
l Gift Options
1. If you are ready to publish the product in the catalog, set the Enable Product switch to the
“Yes” ( ) position.
2. To view the product in your store, choose Customer View on the Admin ( ) menu,
Customer View
Things to Remember
A “code pool” of unique numbers must be generated before a gift card can be offered for
sale.
The three types of gift cards are: Virtual, Physical, and Combined.
The value of a gift card can be set to a fixed amount, or set to an open amount with a
minimum and maximum value.
A gift card account for the customer can be created when the order is placed, or at the time
of invoice.
a. On the Admin sidebar, tap Sales. Then under Operations, choose Orders.
b. Find the order in the list, and in the Action column, click View.
c. Scroll down to the Items Ordered section. The number is in the Product column, under Gift
Card Accounts.
4. Find the gift card account in the grid, and open in edit mode.
The Gift Card Code appears at the top of the Information section.
2. In the upper-right corner, click the Add Gift Card Account button. Then, do the following:
New Account
3. In the Information section, make sure that Active is set to “Yes.” Then, do the following:
a. To make the card balance redeemable at checkout, or transferred to the customer’s store
credit, set Redeemable to “Yes.”
b. Choose the Website where the gift card account can be used.
d. To set an Expiration Date for the gift card, select the date from the calendar . If left
blank, the gift card account will not expire.
In the panel on the left, choose Send Gift Card. Then, do the following:
c. Set Send Email from the Following Store View to the store view that appears as the
sender of the gift card notification.
l If you are not ready to send the gift card, tap Save.
l Tap Save & Send Email to save the changes and send the gift card by email to the recipient.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
a. Set Gift Card Notification Email Sender to the store identity that appears as the sender of
gift card notifications.
b. Set Gift Card Notification Email Template to the template that is used for the notification.
4. Expand the Email Sent from Gift Card Account Management section. Then, do the
following:
a. Set Gift Card Email Sender to the store identity to appear as the sender of the gift cards.
b. Set Gift Card Template to the template you want to use for the gift card.
2. To allow the customer to redeem the value on the card for cash, set Redeemable to “Yes.”
3. In the Lifetime (days) field, enter the number of days before the card expires. Leave the field
blank if there is no expiration date.
Depending on your location, it may be illegal for gift cards to expire. Check your local laws before
setting a lifetime for your gift cards.
4. If you want the customer to have the option to enter a message to accompany the gift card, set
Allow Gift Message to “Yes.” Then in the Gift Message Maximum Length field, enter the
number of characters available for the message.
5. Set Generate Gift Card Account when Orders Item is to one of the following:
Ordered The gift card account is created when the order is placed.
Invoiced The gift card account is created after payment is captured and the order
is invoiced.
6. Expand the Gift Card Account General Settings section. Then, do the following:
l Code Length
l Code Format
l Code Prefix
l Code Suffix
b. To determine the number of codes to generate, enter the New Pool Size.
c. To specify when you receive notification to restock the code pool, enter the Low Code Pool
Threshold.
7. Before you generate the code pool, tap Save Config. Then, tap Generate.
Product Settings
l Managing Pricing
l Managing Inventory
Advanced Links
Other Settings
General Settings
SECTION DESCRIPTION
Content The Content section is used to enter the main product description
that appears on the product page. The short description can be used
in most RSS feeds, and might also appear in catalog listings,
depending on theme. The product description can be formatted using
the editor toolbar.
Product Reviews The Product Reviews section lists all reviews that customers have
submitted about the product. The section appears only after a new
product has been saved.
Images and Videos From the Images and Videos section, you can perform basic image
management tasks such as upload multiple images, rearrange the
order of images, and control how each image is used. For more
control over individual images, you can open each image in “detail
view.”
SECTION DESCRIPTION
Search Engine The Search Engine Optimization section specifies the URL Key and
Optimization meta data fields that are used by search engines to index the product.
Although some search engines ignore meta keywords, others
continue to use them. The current best practice is to incorporate high-
value keywords in both the meta title and meta description.
Related Products, Up- This section is used to set up simple promotional blocks that present
Sells, Cross-Sells a selection of additional products that might be of interest to the
customer.
Product in Websites The Product in Websites section shows the current scope of the
product within the store hierarchy.
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
Gift Options 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
Configurations 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.
Customizable Options Customizable options are based on variations of a single SKU, and
can be a good solution if your inventory needs are simple.
Downloadable Information The Downloadable Information section is used to generate the links
to downloadable products and samples.
Grouped Products The Grouped Products section is used to add items to a Grouped
product type, and also to edit the current selection of items.
Bundle Items The Bundle Items section is used to add items to a Bundle product
type, and also to edit the current selection of items.
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
editor toolbar.
Content
2. At the Description label, tap Edit with Page Builder. Then follow the Page Builder instructions to
edit the existing text, and to add other content, if needed.
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: Configurable
Product.
Configurations Section
Product Configurations
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.
Product Reviews
To upload an image:
1. Open the product in edit mode.
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 .
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.
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: Catalog URLs.
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.
Field Descriptions
FIELD SCOPE DESCRIPTION
URL Key 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.
Meta Title 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 (SERP1). The meta title should be
unique to the page, and less than 70 characters in
length.
Auto-generated value: {{name}}
Meta Keywords Store View Relevant keywords for the product. Consider using
keywords that customers might use to find the
product.
Auto-generated value: {{name}}
Meta 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.
Auto-generated value: {{name}} {{description}}
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
2. Scroll down and expand the Related Products, Up-Sells, and Cross-Sells section. Then,
tap Add Related Products.
Related Products
3. Use the filter controls 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.
Related Products
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
2. Scroll down and expand the Related Products, Up-Sells, and Cross-Sells section. Then,
tap Add Up-Sell Products.
3. Use the filter controls to find the products that you want.
4. In the list, mark the checkbox of any product you want to feature as an up-sell product.
Upsell Products
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.
To show or hide cross-sell items per store view, see the Store > Configuration > Sales > Checkout >
Shopping Cart option called Show Cross-sell Items in the Shopping Cart. You may want to hide
cross-sells during specific sales or for A/B testing in a store view.
2. Scroll down and expand the Related Products, Up-Sells, and Cross-Sells section. Then,
tap Add Cross-Sell Products.
3. Use the filter controls to find the products that you want.
4. In the list, mark the checkbox of any product you want to feature as a cross-sell product.
Cross-sell Products
This section appears only if Google Content Experiments is enabled in the Google Analytics
Google API configuration.
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.
2. Scroll down and expand the Customizable Options section. Then, tap Add Option.
Customizable Options
c. If the option is not required to purchase the product, clear the Required checkbox.
New Option
Add Value
b. In the Price field, enter any markup or markdown from the base product price that applies
to this option.
Fixed The price of the variation differs from the price of the base product by
a fixed monetary amount, such as $1.
Percentage 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.
Customizable Options
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
FILE
SELECT
DATE
Date 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 An input field for date and time values.
Product in Websites
The Product in Websites section identifies each website where the product is available,
according to the store hierarchy.
Multisite Installation
Product in Websites
Product in Websites
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.
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.
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 SCOPE DESCRIPTION
Theme Store View Gives you the ability to apply a different theme to the
product. Options: (All available themes)
Layout Store View Gives you the ability to apply a different layout to the
product page. Options:
Display Product Options In Store View Determines where the product options appear on the
product page. Product Info Column / Block after Info
Column
Layout Update XML Store View Add XML code to customize the theme.
Autosettings
The Autosettings section includes any attributes that are dependencies for other operations.
You can apply the default RMA configuration setting to the product, or override it, as needed.
Autosettings
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
Scroll down and expand the Gift Options section. Then, do the following:
a. To override the default setting, clear the Use Config Settings checkbox.
Downloadable Information
The Downloadable Information section is used to generate the links to downloadable products
and samples. To learn more, see: Downloadable Product.
Downloadable Information
Grouped Products
The Grouped Products section is used to add individual products to a Grouped product. After
the products are added, they appear in the section.
Bundle Items
The Bundle Items section is used to add items to a Bundle product type, and also to edit the
current selection of items.
Bundle Items
l Advanced Pricing
l Group Price
l Special Price
l Tier Price
Advanced Pricing
The Advanced Pricing settings define the conditions required for special pricing that is available
for a specific customer group. Advanced Pricing can be applied to simple, virtual,
downloadable, and bundle products. To apply discounted pricing to other product types, use a
catalog price rule. To learn more, see: Price Scope.
Advanced pricing data is synchronized with product pages. For example, if you update a tier
price quantity, the system updates the value on the product page.
Advanced Pricing
3. Follow the instructions for the type of advanced pricing that is needed.
l Group Price
l Special Price
l Tier Price
Advanced Pricing
Field Descriptions
FIELD DESCRIPTION
Special Price Offers a discounted price during a scheduled campaign.
When a special price is available, the retail price is crossed out and
the special price appears below in large, bold text.
Customer Group Price Sets up promotional and tier prices for specific customer groups for
the current website. Options include:
ALL GROUPS
NOT LOGGED IN
Manufacturer's Suggested The manufacturer's suggested retail price (MSRP) for the product.
Retail Price
Display Actual Price Determines where the actual price of the product is visible to the
customer. Options:
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 customer group prices have a quantity of 1.
2. In the Customer Group Price section, tap Add . Then, do the following:
Group Price
a. For a multisite installation, choose the Website where the group price applies.
c. Enter a Quantity of 1.
l Choose Discount. Then, enter the discounted price as a percentage of the product price.
The following example extends a 10% discount to members of the General customer
group who are logged in to their customer accounts.
3. To add another group price, tap Add , and repeat these steps.
Special Price
A special price can be offered for a designated period of time as a Scheduled Update. During the
specified time period, the special price appears instead of the regular price, followed by a
notation that shows the regular price.
a. In the Update Name field, enter a name for the special price promotion.
c. Use the Calendar ( ) to choose the Start Date and End Date for the special price
promotion. Use the Hour and Minute sliders to choose the start and end time, as well.
Then, tap Close.
d. Scroll down to the Price field, and click Advanced Pricing. Then, enter the amount of the
Special Price.
In the storefront, the Special price should appear in both catalog listing, and on the product
page.
Scheduled Change
Filters
c. Tap Apply Filters.
The grid lists all simple products that are associated as variations of the configurable
product.
Product Variations
3. If you want to assign the same special price to all of the products, set the control in the header
of the first column to “Select All.” Otherwise, mark the checkbox of each product that you want
to include.
Update Attributes
a. Mark the Change checkbox below the Special Price field. Then, enter the special price
that you want to offer.
b. Mark the Change checkbox below the Special Price From Date field. Click the Calendar (
) , and choose the first date of the special price promotion.
The special price goes into effect immediately after midnight at the beginning of the start
date (00:01), and continues until just before midnight (23:59) on the day before the end
date.
c. Mark the Change checkbox below the Special Price To Date field. Click the Calendar (
) , and choose the last date of the special price promotion.
A message indicates how many records were updated with the special price.
The special price becomes available in the store on the date specified, and appears in catalog
listings as well as on the product page. For a configurable product, the regular price also
appears on the product page when the options are chosen.
Troubleshooting
If the special price doesn’t appear correctly in the storefront on both the catalog listing and
product pages, do the following:
Tier Price
Tier pricing lets you offer a quantity discount from a product listing or product page in the
storefront. The discount can be applied to a specific store view or customer group.
If you have many products to update, it is most efficient to import the tier price changes,
rather than enter them individually. To learn more, see: Importing Tier Prices.
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.
3. In the Tier Price section, tap Add. If you’re creating a tier of several prices, tap Add for each
additional level, so you can work all tiers at the same time. Each tier in the group has the same
website and customer group, but a different quantity and price.
a. If your store has multiple websites, choose the Website where the tier pricing applies.
c. In the Qty field, enter the quantity that must be ordered to receive the discount.
2. In the next field, enter the adjusted price for one unit at that tier.
2. In the next field, enter the discounted price as a percentage off the base price of the
product. For example, for a 15 percent discount, enter the number 15. (The price is saved
with two decimal positions, such as “15.00”.)
5. To add another set of tier pricing for a different website or customer group, repeat the process.
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 applied,
according to the product type and price setting. The actual price is used by order management
and customer management tools, and reports.
Configurable 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.
Bundle (with fixed price) 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.
Downloadable 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.
Associated Product Price 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.
MSRP If a product in the cart has the Manufacturer’s Suggested Retail Price
(MSRP) specified, the price is not crossed-out.
Tier Price 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 appears according to the Display Actual Price setting.
Special Price If the Special price is specified, the special price is displayed
according to the Display Actual Price setting.
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.
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.
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.
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.
l In Cart
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.
1. On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.
3. In the panel on the left under Advanced Settings, choose Advanced Pricing. Then, do the
following:
In this example, the product price is $54.00, and the MSRP is 59.95.
On Gesture Displays the actual product price in a popup when the customer
clicks the “Click for price” or “What’s this?” link.
Before Order Displays the actual product price at the end of the checkout
Confirmation 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.
Inventory Management features are supported by the Community Engineering efforts of the Multi
Source Inventory (MSI) project. Learn more about this project and additional developer
documentation in Magento Extensions.
Managing Sources
Create and manage locations that store and ship your
products. Single Source merchants use the Default
Source for all product inventory while Multi Source
merchants use additional custom sources.
Managing Stocks
Create and manage stocks to link your sales channels
or websites to sources. Stocks provide an aggregated
salable quantity of products. Single Source merchants
use the Default Stock while Multi Source merchants
use additional custom stocks.
These descriptions include products, sources, and stocks for a bicycle company with multiple
shipment locations and websites in the United States and Europe.
Sources
Sources are the physical locations where product inventory is managed and shipped for order
fulfillment, or where services are available. These locations can include warehouses, brick-and-
mortar stores, distribution centers, and drop shippers. Magento leverages the quantities and
salable quantities per stock and manages inventory amounts automatically for managed
products and orders. If you have one source, you are considered in Single Source mode. If you
have multiple sources, you are considered in Multi Source mode.
A source can have priority in the scope of stock in one warehouse, but not necessarily in all
warehouses as the source can be re-used in different stocks. The number of stocks and sources
adds to the complexity for determining the best warehouse or store to fulfill an order. For
example, you may have a limited number of products available from your brick-and-mortar
locations with an extensive inventory in your warehouses, and services in key locations with
limited availability.
In this example, the merchant has a mountain bike available for shipment from stores,
warehouses, and a drop shipper.
Stocks
Stocks represent a virtual, aggregated inventory of products available for sale to your sales
channels (currently these are websites). Each stock maps your sales channels with sources for
available inventories and salable quantities. Depending on your site configuration, the stock
may be assigned to one or more sales channels and sources.
Sales Channels represent entities selling your inventory, including websites, stores views, and
so on. Sales Channels can only be associated to one Stock. Each sales channel can only have a
single stock assigned to it, and a single stock can be assigned to multiple websites. Through the
stock, you can modify the prioritization of sources used when shipping orders and by the
Source Selection Algorithm.
You start with a Default Stock assigned with the Default Source and your website, best used by
Single Source merchants. Only the Default Source can be assigned to this stock. Multi Source
merchants create custom stocks for custom sources and websites as needed.
Product Quantities
Quantity is the number of products in your active inventory, available for purchase. The
quantity of products increases and decreases when you complete shipments or adjust
inventory. Adding products to a cart will not affect this amount. The Salable Quantity tracks
the availability of the product for a sales channel and also uses this value for determining
available stock for purchase. Depending on the number of your sources, you see and manage
product quantity for one of the following:
l Quantity: For Single Source merchants, the Quantity column and value tracks the amount
of on-hand inventory available.
l Quantity per Source: For Multi Source merchants, the Quantity per Source column and
values track the on-hand inventory available by location. If you add multiple sources, this
value replaces the Quantity and lists every source and assigned quantity.
Reservations track stock requests for the entire shopping process: adding products to cart,
completing checkout, and managing refunds. For available inventory and stock, reservations
reserve inventory amounts per order through the checkout process, subtracted from the salable
quantity. Reservations convert to quantity deductions when invoicing and shipping products.
Salable Quantity calculates the virtual inventory of products (or availability), taking into
account configured thresholds, reserved or sold amounts, and quantities per source. For each
stock, Magento accesses all assigned sources and aggregates associated product quantities.
With this base value, it then subtracts all reservation amounts and the Notify for Quantity
Below threshold.
Inventory Configurations
Every product, source, and stock includes a number of options to configure for your store at the
global, source, stock, and product level. For a full list of these options, see Configuring
Inventory Management.
l Notify for Quantity Below sets an amount to trigger a low stock warning and subtracts
from your Salable Quantity. If you enable backorders, this value is not deducted from the
Salable Quantity.
l Backorders sets if products can be sold beyond a zero inventory, saving orders until
restocked. When enabled, we recommend configuring the Out-of-Stock Threshold.
l Out-of-Stock Threshold indicates when a product is out of stock and cannot be sold
further. The value supports negative and positive amounts. If you enable backorders, we
recommend setting this value to a negative amount for the maximum amount of products
that can be backordered before the product is truly considered out of stock.
The heart of Inventory Management tracks every available product virtually and on-hand in
your warehouses and stores. The Source Selection Algorithm and Reservations systems run in
the background, keeping your salable quantities updated, checkout free of collisions, and
shipment options recommended.
With multiple source locations, global customers, and carriers with various shipping options
and fees, knowing your actual available inventory and finding the best shipment option can be
difficult. SSA does the work for you from tracking inventory salable quantities across all sources
to calculating and making recommendations for shipments.
Track Inventory: Using stocks and sources, the SSA checks the sales channel of incoming
product requests and determines available inventory:
l Calculates the aggregated virtual salable quantity of all assigned sources per stock:
aggregates Quantity - Out-of-Stock Threshold per source
l Subtracts the Out-of-Stock Threshold amount from salable quantity to protect against
overselling
Manage Shipments: The algorithm helps when you process and ship orders. You can run the
algorithm to get recommendations on the best sources for shipping the product or override the
selections to:
l Ship partial shipments, sending only a few products from specific locations and completing
the full order at a later date
l Break the shipments across multiple sources in different amounts to keep a balanced stock
across all warehouses and stores
SSA is able extensible for third party support and custom algorithms for recommending cost
effective shipments.
SSA functions differently for Virtual and Downloadable products, which may not incur shipping
costs. In these cases, the system runs the algorithm implicitly when it creates invoices, and always
uses the suggested results. You cannot adjust these results for Virtual and Downloadable products.
l Works through the configured order of sources at the stock level starting at the top
l Recommends a quantity to ship and source per product based on the order in the list,
available quantity, and quantity ordered
To configure, assign and order sources to a custom stock. See Prioritizing Sources for a Stock.
The following example details the mapped sources in order, available quantity, and
recommended source and amount to deduct and ship. The top source is a Drop Shipper in the
United Kingdom with an available quantity of 240.
You have two options for calculating the distance and time to find the closest source for
shipment fulfillment:
l Google MAP: Uses Google Maps Platform services to calculate the distance and time
between the shipping destination address and source locations (address and
GPS coordinates). This option uses the source's Latitude and Longitude. You must provide a
Google API key with Geocoding API and Distance Matrix API enabled. This option requires a
Google billing plan and may incur charges through Google.
l Offline Calculation: Calculates the distance using downloaded and imported geocode
data to determine the closest source to the shipping destination address. This option uses
the country codes of the shipping address and source. To configure this option, you may
require developer assistance to initially download and import geocodes using a command
line.
To configure, select configurations and complete additional steps such as the Google API key or
downloading shipping data. See Configuring Distance Priority Algorithm.
Custom Algorithms
Magento supports custom development and extensions to add alternative algorithms to
prioritize sources. For example, you can have one priority algorithm based upon geography and
another based upon expense of stock or a customer attribute. When the cost of stock changes,
your implementation can easily change algorithms to ensure the lowest cost.
Reservations
Instead of immediately deducting or adding product inventory quantities, reservations hold
inventory amounts until orders ship or cancel. Reservations work entirely in the backend to
automatically update your salable quantity at the stock level.
Order reservations
Reservations place holds on inventory quantities deducted from the salable quantity when
submitting an order. The reservations are at the stock level, counting against quantities until
the order is invoiced and shipped, canceled, etc. When shipping the order, you can use the SSA
recommendations or manually enter quantity deductions per source. When shipped, the
reservations are automatically cleared and the quantity deducted. The salable quantity
recalculates for the stock with an updated quantity and any reservation amounts still in the
system.
The following diagram helps define the process of reservations during an order and through to
shipment.
A customer submits an order. Magento checks the current inventory salable quantity. If enough
inventory is available at the stock level, a reservation enters placing a temporary hold for the
product SKU (for that stock) and recalculates the salable quantity.
After invoicing the order, you determine the product amounts to deduct and ship from your
sources. The shipment is processed and sent from the selected source(s) to the customer. The
quantities automatically deduct from the source inventory quantity and reservations clear. For
complete details and examples, see About Order Status and Reservations.
Updating Reservations
As changes complete in orders and product amounts, Magento automatically enters reservation
compensations. You do not need to enter compensations through the Admin or code to update
or clear these holds. Reservations are only affected by entered reservations to put a hold on a
quantity or to clear a hold amount (compensating the reservations).
l Submitted Order: When an order submits for an amount of products, a reservation enters
for that amount. For example, ordering 5 backpacks from a US website enters a reservation
of -5 for that SKU and stock. The salable quantity is reduced by 5.
l Shipped Order: When an order ships (all or partial), a compensation reservation enters to
clear that amount. For example, shipping 2 backpacks enters a +2 reservation for that SKU
and stock, clearing the hold. The product quantity is directly reduced by 2 for the shipment.
The calculated salable quantity is also updated for the reduced stock amount, but no longer
affected by the reservation.
Developer options: If you want to review reservations, a series of command line options are
available. You can only review reservations through a command line interface. Using CLI
commands may require developer assistance. See Inventory Management CLI Reference.
If you remove all sources from a product for a stock with pending orders, you may have stuck
reservations.
Important: Unassigning a source clears all quantity data. Reassigning a source with quantity data can
potentially cause issues with pending orders with reservations and affect stock salable quantity counts.
Keep in mind, all product quantities in shopping carts and submitted orders have associated
reservations. If you unassign the only sources providing those products to the stock, orders cannot be
completed and shipped for that sales channel.
Recommendation: We recommend processing all pending orders and sending shipments prior to
removing sources or transferring all inventory.
quantity for a stock (or sales channel) and the on-hand inventory quantity per source. You do
not have to actively access or enter reservations. Completing actions to fulfill, cancel, or refund
an order does it for you.
These reservations always add to your salable quantity, with positive or negative amounts to
increase or decrease quantities. These reservations are compensations, updating your on-hand
inventory and salable quantities for up-to-date amounts for your store.
For specifics on orders and shipments, see Managing Orders and Shipments.
Shipments
After invoicing orders, send partial or full shipments until you fulfill the entire order. Each
shipment converts reservation, deducting the amount from the product quantity per source.
Reservation compensations enter to update the salable quantity for your stock. If you send
partial shipments, each shipment deducts that amount from your product quantity and
reservations. Any unshipped product reservations remain in place until they are also shipped
at a later time. This keeps your salable amount current, gives you control over product
inventory, and supports multiple source shipments and backorders.
Canceled orders
If a customer cancels their order prior to shipment (partial or in full), a new reservation is
entered to return the inventory amount to the salable quantity. The reservations effectively
cancel each other out, not deducting the quantity from any sources. Other customers can
actively purchase those product quantities through the associated stocks and sales channels.
Refunded orders
If a customer requests a refund, issue the credit memo for the partial or full product amounts.
When you receive the returned products, enter a credit memo to provide the funds and update
product amounts. When selecting the Return to Stock option, Magento adds quantities back
to the product SKUs and sources that shipped the orders and reservation compensations to
update salable quantities for the associated stock.
Order types
Simple orders begin with a shopping cart, continue to payment, and end with a satisfied
delivery. In these orders, Inventory Management easily processes reservations against the
availability (or salable quantity) in the cart and checkout, and deducts from the on-hand
inventory at shipment.
CREDIT
MEMO RESERVATION FOR SALABLE
STATUS DESCRIPTION QUANTITY
Complete Paid and shipped in full Reservation amount deducts from product
quantity for the selected source when
invoiced partial or in full
Reservation compensation entered to
update the total salable quantity
CREDIT
MEMO RESERVATION FOR SALABLE
STATUS DESCRIPTION QUANTITY
Open The refund is due, not completed No change in reservations
She buys two great park bikes for her daughters, a BMX bike for her son, a nice mountain bike
for herself, and a modern German cross-country bike for her husband. The store had a sale on
cute shirts, so she bought some for the whole family to match. See the list of vacation
purchases below, the matching SKUs, and the reservations entered against the stock salable
quantities.
She shows her family the great finds, but makes some changes. Before payment completes, she
cancels two of the 33-BikeFun SKUs (her daughters did not like them). This is a partial
cancellation due to payment pending, so no credit memo needed. To update, Magento adds
back to the salable quantity stock for Canada. The order is paid and all products ship, arriving
in time for vacation! Magento updates the salable quantity and source quantities for the
shipping warehouses for the shipped products.
But her husband didn't quite fit in the shirt. Jenny requests a refund and sends back his shirt.
When creating the credit memo, this adds one 54-BikeLife shirt back to the Canada stock and
shipping warehouse.
l Shipped products: With products purchased and shipped, Magento updates the
inventory. Reservation compensations convert to on-hand inventory quantity deductions
from the shipped source. The available salable quantity updates for the stock.
l Canceled products: By canceling stock, Magento removes the reservation for that
product. Reservation compensation is entered to the stock level to add back salable
quantities for the partial cancellation of two shirts. This does not affect the inventory
quantity at the source level.
inventory quantity to the shipped source for the product. Reservation compensations enter
to clear any remaining reservations. The salable quantity recalculates against the updated
quantity.
l Single Source merchants create and update product settings and quantities without
requiring additional updates. All created and newly imported products automatically assign
to the Default Source and Default Stock, immediately available to customers if enabled and
In-Stock.
l Multi Source merchants assign sources, quantities per source, and settings during or after
product creation. Magento assigns all newly imported products to the Default Source,
requiring additional edits to assign sources and quantities.
Supported Products
SHIPPING AND
SOURCE
PRODUCT SINGLE MULTI SOURCE AND SELECTION
TYPE SOURCE SOURCE STOCK ALGORITHM
Simple Yes Yes Default Source Supports SSA
recommendations
Default Stock
and overrides at
shipping
You cannot
adjust these
results.
You cannot
adjust these
results.
shipping
l Single Source merchants ship products from one location. You are considered a Single Source
merchant/mode until you start adding custom sources and stocks to your installation.
l Multi Source merchants ship products from more than one location such as brick-and-
mortar stores, warehouses, drop shippers, and distribution centers. After adding custom
sources per location, you automatically become a Multi Source merchant or mode.
For example, you have one website or a multisite implementation with sites for United States,
Germany, France, and Brazil all pulling products from one large warehouse. This single source
manages all inventory quantities, shipments, and returns regardless of which sales channel
receives the order.
l Configure global and product settings for your store's inventory as needed.
l Update the Default Source with information for your single inventory location. You don't
need to create additional sources.
l Update the Default Stock. Ensure all of your websites are selected as sales channels. As you
add new websites, Magento automatically adds them to the Default Stock. You don't need to
create additional sources.
As your business expands, add additional sources and stocks and update your inventory
management configuration to become a multi source merchants. See Expanding to Multi Source
Inventory for all details.
For example, you have a multisite implementation with websites for United States, Germany,
France, and Brazil. Your business includes a number of warehouses and stores in these
countries and drop shipper services that manage all inventory stock and fulfill orders. These
locations and websites become sources and stocks in Magento. You may create a stock for the
Americas and another for Europe, assigning websites and sources based on locales and
locations. Customers shopping each website only have access to salable inventories from the
assigned sources.
l Add custom sources for your inventory locations: warehouses, stores, distribution centers,
and drop shippers.
l Add custom stocks for each region to map your websites with a number of sources. Reorder
the sources in each stock in priority of location, helpful when fulfilling your orders.
l Complete any further configurations per product for quantity thresholds, backorders, and so
on.
l Add custom sources for each new location. You will only use the Default Source for Bundle
products.
l Add custom stocks as needed for your new sources. For example, you may want to create
stocks per website, country, locale, or other method. You can assign sources to your custom
stocks. You will only use the Default Stock for Bundle products.
l Update source assignments and quantities for your products. You can also use the Mass
Actions Tool and Magento Import-Export feature to quickly add sources and product data.
l Transfer product inventory to your Default Source. We recommend using mass actions. See
Transferring Inventory to Source.
If upgrading to Magento v2.3.x, this information provides details on new features and changes
to your existing catalog and Inventory configurations.
Magento Inventory Management includes features, enhancements, and developer support that
enhances and updates all product stock management and add new features. All features are
available out-of-the-box including the Source Selection Algorithm and Concurrent Checkout to
match order quantities to sources and order fulfillment. Depending on your websites, stores,
and merchant type, you can create additional stock and sources, assigning inventory amounts,
and more. For complete information, see Inventory Management and Learn about Inventory
Management.
When first installing or upgrading to Magento 2.3.x Open Source, Commerce, or Commerce
Cloud, the following initial changes occur:
l Inventory Management enables at the global store or product level. The Manage Stock option
enables or disables tracking of inventory quantities, calculations of aggregated salable
quantities, and reservation management for tracking purchases through to invoice and
shipment. You can disable this option to use an ERP and other third party services for
managing stock, orders, and shipments. For additional information, see Inventory
Management Modules below.
l A Default Source and Default Stock add to the system. Do not disable or remove these
defaults. Magento assigns existing and newly imported products to these defaults.
l Stocks provide an aggregated, virtual Salable Quantity with reservations to track
shopping carts and orders, ensuring concurrent checkout.
l All existing products in your catalog assign to the Default Source. Until you add new
sources, the product interface does not change. If you only ship products from one
location, you will not see additional differences for sources. You can create custom
sources and assign quantities per shipment location.
l Your website assigns to the Default Stock. You can create custom stocks to connect sales
channels (websites) and sources (locations).
l Additional configuration options add to your products and global store. Some existing
configurations options receive updated options and behaviors:
l Notify for Quantity Below sends notifications and deducts from the Salable Quantity.
l Out-of-Stock Threshold supports positive amounts, zero, and negative amounts. With
Backorders enabled, positive amounts are ignored, considered zero (or infinite).
l Backorders supports zero (infinite) and negative amounts. When enabled, the Notify for
Quantity Below does not deduct from the Salable Quantity.
l New Reservations track potential sales, converting to quantity deductions when the order
ships. You never directly access or create reservations. Magento creates and manages
reservations behind-the-scenes through orders, shipments, and credit memos.
l Orders and shipments include new features to recommend shipments using the Source
Selection Algorithm and support partial shipments from multiple sources to fulfill an order.
l New import/export features allow you to mass add sources, update inventory quantities,
and set stock status (in/out of stock) for all SKUs in your catalog. These features allow you
to modify for one, selected, or all sources.
l New bulk options through the Product grid page support assigning sources, unassigning
sources, and transferring inventory to sources.
We may support integrations between Magento Inventory Management (also known as MSI)
and Magento Order Management in a later release.
Magento Order Management provides extensive features and services for advanced
omnichannel order management, global inventory and multisourcing, store to warehouse
fulfillment, and centralized customer service. For a complete list of features, see the OMS
Feature list.
Magento Inventory Management extends existing Magento features with additional options to
track in-flight orders, on-hand inventory, available inventory for a stock, and APIs for extension
development.
l Use Magento Order Management for inventory management. The current connector does not
support Inventory Management interfaces. For OMS merchants upgrading to Magento 2.3.x,
they need to disable these modules.
For complete details, see the DevDocs Manage Inventory Management modules.
Your catalog can be configured to display inventory data in your storefront, manage active
shopping carts, and more. Display the availability of each item as “In Stock” or “Out of Stock”
and the available inventory when stock is low.
The out of stock threshold indicates when a product needs to be reordered, subtracts from the
Salable Quantity for a stock, and can be set to support enabled or disabled backorders. Allow
backorders for your store, setting a maximum amount of orders for all or specific products.
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.
Configuration options
Magento stores and products support the following configurations for managing products,
inventory, notifications and more. Magento provides additional configuration settings for bulk
actions and the Distance Priority algorithm. For complete details, see Inventory configuration
information.
OPTION DESCRIPTION
Manage Stock Enables Magento to manage all inventory. Sets if inventory
control is used for this product or all products in Magento.
Displays more options if set to Yes.
Only X left Threshold Sets a quantity amount to notify when a specific amount is left
available for purchase. This amount is tracked at the stock level.
Minimum Qty Allowed in Sets the minimum quantity of the product that can be purchased
Shopping Cart in a single order.
Maximum Qty Allowed Sets the maximum quantity of the product that can be purchased
in Shopping Cart in a single order.
Qty Uses Decimals Allows decimal amounts, instead of whole numbers, for the
quantity of a product. This is helpful for products sold by weight,
volume, or length. Specified on the level of Source, calculated on
the Stock level based on assigned Sources.
Allow Multiple Boxes for Sets if parts of a product can be shipped separately.
Shipping
OPTION DESCRIPTION
Notify for Quantity Sets the quantity that triggers a Quantity Below notification,
Below warning of low stock. This amount is deducted from the Salable
Quantity, not from the inventory Quantity.
Enable Qty Increments Sets if the product can be sold in quantity increments. If enabled,
enter the quantity of products that must be purchased in an
incremental step.
Automatically Return Inventory Management does not use this value. When you
Credit Memo Item to complete a return or Credit Memo, the product quantity is
Stock automatically returned to the affected source quantity.
When Magento checks for custom settings to apply, it follows this order:
1. Magento checks for custom settings at the Product level in the Sources section. A few settings
are available.
3. If Use Config Settings is selected for the product settings, it checks for a value in the Stores
> Configuration > Inventory page.
For example, you may configure backorders differently across your store. You may have
backorders configured as follows:
l Globally: Enable backorders for the store, set Out-of-Stock Threshold to -50
Your business runs and inventory updates at the speed of sales. As customers shop, you receive
exact, updated information for available stock per sales channel and source. Available salable
quantities update per stock when customers add products to cart and complete purchases and
when and you manage orders, create shipments, and issue refunds. Arrivals of new or
transferred stock update to your sources, immediately available for online sales. Backorders
complete up to specified thresholds without infinite orders or additional configurations. And
you enter and complete partial or full shipments across one or more sources with
recommendations, giving you complete control over order fulfillment and on-hand inventory.
l Manage Stock settings at the product level override the store configuration.
l To use Magento Order Management or third party services such as ERP, disable Manage
Stock.
l If the product level configuration uses the system default, the store configuration overrides.
With Inventory Management enabled, see the following to configure all settings:
l Configuring Global Options: Settings that affect your entire catalog, considered the system
default settings
l Configuring Product Options: Settings for a specific product that override global options
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
l To disable Magento Inventory Management, select No. You may need to clear the Use
system value checkbox.
l To disable Magento Inventory Management, select No. You may need to clear the Use
system value checkbox.
a. To adjust the quantity on hand when an order is placed, set Decrease Stock When Order
is Placed to “Yes.”
b. To return items to stock if an order is canceled, Set Items’ Status to be in Stock When
Order in Cancelled 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 price alerts are enabled, customers can sign up to be notified when the product is back in
stock.
d. Enter an amount for Only X left Threshold to start displaying the last remaining
inventory amount on the product page.
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.”
Stock Options
a. To activate inventory control for your catalog, set Manage Stock to “Yes.”
Allow Qty Below 0 To accept backorders when the quantity falls below zero.
Allow Qty Below 0 and To accept backorders when the quantity falls below zero, and
Notify Customer notify the customer that the order can still be placed.
e. Enter the Minimum Qty Allowed in Shopping Cart for selected group and amounts.
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. For Inventory Management, Automatically Return Credit Memo Item to Stock is set to
"No." When submitting a credit memo, you enter and select to return stock to sources.
a. Set Run asynchronously to run bulk operations asynchronously for mass product actions
including bulk assign sources, unassign sources, and transfer inventory to source. It
collects bulk actions up to the Asynchronous batch size, then runs those actions. This
option is disabled by default. We recommend reviewing your performance with bulk
actions before enabling.
Important: To configure and support asynchronous queue managers, you need to issue a
command using the command line. This step may require developer assistance. See
Magento DevDocs, Start message queue consumers.
b. If enabled, set the Asynchronous batch size. The default batch size is 100. When bulk
processes reach this amount, they perform them at that time.
3. Expand the Sources section, and configure product settings per source:
c. To modify the Notify for Quantity Below per source, clear or select the Notify Quantity Use
Default checkbox. If cleared, enter the stock level that triggers notification that the item is
out of stock. This amount is subtracted from the Salable Quantity at the stock level.
Select to use Default Magento checks the product Advanced Inventory options for
configuration settings.
Clear to Modify Enter a value for the Notify Quantity, overriding Advanced
Inventory and Store configuration settings.
Field Descriptions
FIELD SCOPE DESCRIPTION
Source Item Status Global Determines the current availability of the product.
Options:
Notify Quantity Global An amount for the Notify for Quantity Below for this
specific source if Notify Quantity Use Default is not
selected.
Notify Quantity Use Global Indicates to use the default setting for Notify for
Default Quantity Below in the product Advanced Inventory or
global setting in Store configuration.
a. To activate inventory control for your catalog, set Manage Stock to “Yes.”
e. Set Qty uses Decimals to Yes/No if customers can use a decimal value rather than a
whole number when entering the quantity ordered.
f. Set Allow Multiple Boxes for Shipping to Yes/No if the product can be sold separately, in
many boxes.
g. Set Backorders to one of the following. For complete information on backorders, see
Configuring Backorders.
Allow Qty Below 0 To accept backorders when the quantity falls below zero.
Allow Qty Below 0 and To accept backorders when the quantity falls below zero,
Notify Customer and notify the customer that the order can still be placed.
h. In the Notify for Quantity Below field, enter the stock level that triggers notification that
the item is out of stock. This amount is subtracted from the Salable Quantity at the stock
level.
i. 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.
Field Descriptions
FIELD SCOPE DESCRIPTION
Manage Stock Global Determines if inventory control is used to manage this
product in your catalog. Options:
Minimum Qty Allowed in Global Determines the minimum number of the product that
Shopping Cart can be purchased in a single order.
Maximum Qty Allowed in Global Determines the maximum number of the product that
Shopping Cart can be purchased in a single order.
Qty Uses Decimals Global Determines if customers can use a decimal value
rather than a whole number when entering the quantity
ordered. Options:
Allow Multiple Boxes for Global Determines if parts of the product can be shipped
Shipping separately. Options: Yes / No
Notify for Quantity Below Global Sets the quantity that triggers a Quantity Below
notification, warning of low stock. This amount is
deducted from the Salable Quantity, not from the
inventory Quantity.
Enable Qty Increments Global Determines if the product can be sold in quantity
increments. Options: Yes / No
Configuring Backorders
Backorders allow your store to continue selling products after the quantity reaches zero, or is
effectively out of stock. When a customer order is a backorder, the funds are authorized and
captured immediately, the processing status of the order does not change, and the shipping
remains on-hold until stock is available.
Depending on your store and sales, you may want to enable or disable backorders at the
following levels:
l Product - Specific products overriding settings for site, source, and stock
Out-of-Stock Threshold
Use a negative value for this threshold to set the maximum amount of products that can be
backordered before the product is truly considered out of stock. This amount adds to the
salable quantity. The value set at the product level overrides any value set at the global level.
The formula for the Salable Quantity is: (Quantity - (out-of-Stock Threshold).
l Quantity: 25
The Notify for Quantity Below configuration option is configurable at the global, source, and
product levels. It sends an email notification when a product's quantity reaches a low quantity.
For this example, the notification sends when the product has a quantity of 10 or less. When
backorders are enabled, the Notify for Quantity Below is not deducted from the Salable
Quantity.
Stock Status
Products must be set to In Stock status when enabling backorders. You can set this through
the Product page. For multi source merchants, you must have at least one source marked as In
Stock. Access and set the status through the product page and assigned sources grid.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
4. Expand the Product Stock Options, and locate Backorders. Clear the Use system value
checkbox and select an option from the drop-down menu:
Allow Qty Below 0 To accept backorders when the quantity falls below zero.
Allow Qty Below 0 and To accept backorders when the quantity falls below zero, and
Notify Customer notify the customer that the order can still be placed.
5. Expand the Product Stock Options, and locate Out-of-Stock Threshold. Clear the Use
system value checkbox to enter a different amount.
2. Locate and open a product in Edit mode. Scroll down the page to the Sources area.
3. Tap Advanced Inventory. A page of product specific configurations displays. Any setting listed
as global displays the current global setting for the store.
4. Locate Backorders and clear the Use Config Setting checkbox and select an option from the
drop-down menu:
Allow Qty Below 0 To accept backorders when the quantity falls below zero.
Allow Qty Below 0 and To accept backorders when the quantity falls below zero, and
Notify Customer notify the customer that the order can still be placed.
5. Locate Out-of-Stock Threshold and clear the Use Config Setting checkbox to enter an amount:
l Works through the configured order of sources at the stock level starting at the top
l Recommends a quantity to ship and source per product based on the order in the list,
available quantity, and quantity ordered
To configure, arrange those sources from top-to-bottom in priority for fulfilling orders. The
Source Selection Algorithm (SSA) provides an algorithm Priority using this order when
determining shipment and inventory deductions. See Prioritizing Sources for a Stock.
Important: When using the Distance Priority algorithm for shipping, if routes and data do not
return for the selected Computation mode (driving, bicycling, or walking) for a shipment, the SSA
defaults to using the Source Priority.
We recommend entering the full street address and GPS coordinates for your sources if using the
Distance Priority algorithm.
You have two options for calculating the distance and time to find the closest source for
shipment fulfillment:
l Google MAP: Uses Google Maps Platform services to calculate the distance and time
between the shipping destination address and source locations. This option uses the source's
Latitude and Longitude (GPS coordinates) and may use the street address depending on the
computation mode. This option uses the source's Latitude and Longitude. You must provide
a Google API key with Geocoding API and Distance Matrix API enabled, and may incur
charges through Google.
l Offline Calculation: Calculates the distance using downloaded and imported geocode
data using zip/post codes and GPS coordinates to determine the closest source to the
shipping destination address. To configure this option, you may require developer assistance
to initially download and import geocodes using a command line.
2. To enable the platform, select Maps, Routes, and Places and click Continue.
4. Set up a project:
c. Click Next.
5. Enter a billing account, or create one. You can skip and add a billing account later. The
account is required to use this service.
6. Click Console to open and configure your Google Cloud Platform options.
b. Expand the menu and click APIs & Services > Library.
Google API Services
c. Search for Geocoding API and Distance Matrix API. Select and enable each service.
7. Expand the menu and click APIs & Services > Credentials. Copy the Google API Key.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
3. Expand the Distance Provider for Distance Based SSA section, and set Provider to
"Google MAP".
4. Expand the Google Distance Provider section, and configure the settings:
Important: When using this algorithm for shipping, if routes and data does not return for the
selected Computation mode (driving, bicycling, or walking) for a shipment, the SSA defaults to
using the Source Priority. We recommend also setting the priority for sources per stock.
Time to Destination Returns the time required to travel from the source locations to
the shipping address in hours and minutes
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
3. Expand the Distance Provider for Distance Based SSA section, clear the Use system
value checkbox and set Provider to "Offline Calculation".
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.
In-Stock Alerts
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.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
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. The default email template is selected for your theme. To create a new email
template, see templates below.
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 store contact that you want to appear as the sender of the
email alert.
Product Alerts
1. On the Admin sidebar, tap Marketing. Then under Communications, choose Email Templates.
3. Under Load default template, in the Template list, choose the template that you want to
customize. This may be the alert template from your theme. Or you can select the Price Alert or
Stock Alert templates under Magento_PriceAlert. Tap Load Template.
4. Enter a Template Name. You can select this name in the Price Alerts configuration.
5. Read through the existing content and make changes as needed for the following:
6. To add generated information from Magento data, use the Insert Variable option. A list of
available variables displays.
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.
Product Inventory
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.
Product Inventory
Product Inventory
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.
Product Inventory
Managing Sources
Sources represent locations storing and shipping your product stock. Any location with
available stock and capable of order fulfillment can be added as a source such as warehouses,
brick-and-mortar stores, distribution centers, and drop shippers.
Sources are the physical locations where product inventory is managed and shipped for order
fulfillment, or where services are available. These locations can include warehouses, brick-and-
mortar stores, distribution centers, and drop shippers. You allocate inventory quantities to
these sources, and Magento automatically aggregates the total salable products for your stocks.
For large companies, add multiple sources for all of your locations: in different geographic
locations by country and continent, locations in a city, based on the type of inventory, even
based on services.
You start with a Default Source you can update but not disable. This source is used by Single
Source Merchants and for product migration. You always need a default source.
l Location Information - Each source includes the name, country, physical address of the
location, and a point of contact.
l Enabling Resources - You can enable and disable sources as needed. Only enable a
source if it accepts and fulfills orders and backorders.
l Available Inventory - Assign and update inventory quantities for each source through the
product page. The inventory quantities are calculated, provided, and reserved through the
source and stock mapping. See Managing Inventory Quantities.
The following diagram helps define the Sources for a Bicycle Shop merchant selling a mountain
bike, available to stocks and accessible by the SSA for shipments.
l All new products imported into Magento require a source and stock, automatically assigned
for immediate access to inventory management.
l Single Source merchants use the Default Source as their single point of inventory location
and shipments.
l Bundle products currently do not support multi-sourcing and must be assigned to Default
Source and Default Stock.
Editing Sources
You can update the name, address, GPS location, and point of contact information. The
source's code is a protected value, acting as a unique ID associating the source with your
product quantities and stocks.
If editing the Default Source, you can edit all configurations except the code. We recommend
Single Source merchants add information for their location, including the address, a contact,
and GPS coordinates.
The Manage Sources page lists all available inventory locations and fulfillment facilities. You
can add new inventory sources, and edit existing locations.
3. Find the inventory source and open in Edit mode. Then, update the information, and save the
changes.
Manage Sources
Button Bar
COLUMN DESCRIPTION
Add New Source Opens the New Source form that is used to enter a new inventory
source, fulfillment facility, or location.
Column Descriptions
COLUMN DESCRIPTION
Code A unique, alphanumeric code that is used by the system to identify
the inventory source. You cannot edit this value after creating a
source.
Name A unique name that identifies the inventory source for Admin users.
If editing the Default Source, you can edit all configurations except name and code. We
recommend single source merchants add information matching their location.
Manage Sources
b. Enter a unique Code. The code supports upper and lower case letters, numbers, dashes,
and underscores. The code is a unique ID used when assigning to stock and exporting-
importing data.
d. Enter a brief Description for this location for quick reference or additional details.
e. In the Latitude and Longitude fields, enter the Global Positioning System (GPS)
coordinates of the facility location.
To find the GPS coordinates with Google Maps, enter the address in the Search box. Right-
click the marker on the map and choose What’s here? The GPS coordinates appear in the
details box below the street address.
General
a. For the Contact Name, enter the full name of the primary contact at the location.
c. For the Phone, enter the area code and phone number.
d. In the Fax field, enter the area code and phone number of the fax, if available.
Contact Info
b. For the State/Province, enter the standard abbreviation for the state or province.
Address Data
l To save your work and continue editing, tap Save & Continue.
l To save your work and return to the Manage Sources page, tap the down arrow ( ) and
choose Save & Close.
l To save your work on the current source record and enter a new source, choose Save & New.
Button Bar
COLUMN DESCRIPTION
Back Returns to the Manage Sources page.
Reset Restores all fields in the form to their values at the time of the last
save.
Save & Continue Saves all changes, and keeps the form open for further editing. Click
the down arrow for these additional options:
Field Descriptions
FIELD DESCRIPTION
GENERAL
Name (Required) A unique name that identifies the inventory source for
Admin users.
Latitude Specifies the latitude coordinate of the inventory source for GPS.
Enter the value as a number, preceded by a plus or minus sign as
needed. The degree symbol and letters are not permitted. For
example:
Latitude 32.7555
Longitude Specifies the longitude coordinate of the inventory source for GPS.
Enter the value as a number, preceded by a plus or minus sign as
needed. The degree symbol and letters are not permitted. For
example:
Longitude -97.3308
CONTACT INFO
Contact Name The name of the primary contact at the inventory source location.
Phone The area code and telephone number of the primary contact, using
the format that you prefer. For example: (123) 456-7890 or 123-456-
7890
Fax The area code and fax number of the primary contact.
ADDRESS DATA
Disabling Sources
Sources may not be deleted to ensure all order data retains in Magento. Sources, orders, and
shipments are directly connected to each other. You can disable sources and modify
information including location and point of contact.
Depending on the status of your locations, you may need to disable a source. A disabled source
retains all assignments per stocks and products but is not accessed for inventory and orders:
When disabled:
l Inventory Management ignores and does not list the source for shipment or order
processing.
l Stocks do not access inventory quantities from the source for aggregated inventory totals.
You cannot disable the Default Source. Magento uses this source for all new, imported
products, for bundle products, and for third party system support. You can enable or disable
custom sources at any time.
l Adding a new store or warehouse: As you open new storefronts or bring new
warehouses and shipment locations online, add a source entry to set up product inventory
using import and connect to potential stocks.
l Seasonal shipments: Holidays can be an extremely busy time of the year. You may want
to restrict shipping only from specific shipment locations such as warehouses to keep brick-
and-mortar locations well stocked and focused on local shoppers. Or you may add new
shipment locations for a limited time to handle higher rates of sales and incoming orders.
To disable a source:
1. On the Admin sidebar, tap Stores. Then under Inventory, choose Sources.
Managing Stock
Stock represents a virtual, aggregated inventory of products for sources of your sales channels
(currently these are websites). Depending on your site configuration, the stock may be assigned
to one or more sales channels. Each sales channel can only have a single stock assigned to it,
and a single stock can be assigned to multiple websites. Through the stock, you can modify the
prioritization of sources used as orders come through a website.
You start with a Default Stock that cannot be removed or disabled. You can add additional
sales channels to the stock only. The only assigned source is Default Source. This stock is used
by Single Source Merchants, 3rd party integrations, and imported products.
Sales Channels represent entities selling your inventory. By default, Magento provides your
store websites as sales channels. Sales channels can be extended to support additional channels
such as B2B customers groups and store views. Each sales channels can only be associated to
one Stock.
l Sales Channel Support - Sales channels currently include websites out-of-the-box. You
can extend sales channels to include custom options like B2B customers groups and store
views. Each sales channel can only have a single stock assigned to it. A single stock can be
assigned to multiple websites.
l Map to Sources - Each stock can have one or more enabled or disabled sources assigned,
calculating the virtual aggregated inventory per product.
l Priority Order Fulfillment - The out-of-the-box Priority algorithm for the Source
Selection Algorithm uses the stock's source list from top-to-bottom when fulfilling orders.
The following diagram helps define how a Stock works in relation to Sources and Sales
Channels for a Bicycle Shop merchant.
All stores start with a Default Stock. It must remain "Enabled" for the following:
l It is used when importing new products, automatically assigning products to the default
source and stock for immediate access to Inventory Management.
l You cannot add additional sources beyond the Default Source to this stock.
l It is required and used by Single Source merchants, Bundle products, and Grouped
products.
For Multi Source merchants, create and configure stocks as needed to best fit your stores and
order fulfillment. When you assign new stock to a sales channel, any pre-existing stock in that
sales channel becomes unassigned.
For a multisite installation, the Default Stock is initially assigned to the Main Website and
default store.
Manage Stock
Button Bar
COLUMN DESCRIPTION
Add New Stock Opens the New Stock form that is used to enter a new inventory
stock for mapping inventory to sales channel.
Sales Channels Defines the scope of the stock by assigning the stock to specific
website(s) as “sales channels.”
Assigned sources Sources assigned to the stock that supply all product quantities.
When creating a custom stock, you assign websites and sources. Sources can include enabled
and disabled sources. For example, you may add a new warehouse to your stock, preparing to
open the location for managing inventory and completing shipments.
After adding sources, you need to prioritize the order for the sources from top (first) to bottom
(last). This order affects recommendations during order shipment.
New Stock
3. Expand the General section. Then, enter a unique Name to identify the new stock.
General
4. Expand the Sales Channels section. Then, select the Websites where this stock is
available. For a multisite installation, hold the Ctrl key and tap each website.
If you select a website or sales channel assigned to another stock, it will be unassigned from that
stock. Any Sales Channels not assigned to a custom stock are assigned to the Default Stock.
Sales Channels
5. Expand the Sources section. For any stock other than the default, do the following:
Assigned Sources
b. Select checkboxes for all sources you want to assign to the stock.
6. Use to drag and drop the sources into a priority from top (first) to bottom (last). This order is
important when shipping orders.
Field Descriptions
FIELD DESCRIPTION
GENERAL
SALES CHANNELS
Websites Defines the scope of the stock by assigning the stock to specific
website(s) as “sales channels.”
Select one or more websites per stock. Each website can only be
assigned to one stock.
SOURCES
Assigned Sources List of assigned sources. Drag and drop the sources using into a
prioritized order for order fulfillment and shipping.
The source priority on stocks does not influence assigned sources when editing product
inventories.
In this example, the UK Stock has sources assigned out of order for a store and two warehouses
in London and a warehouse in Berlin.
Use to drag and drop the sources into a priority from top (first) to bottom (last). This order is
important when shipping orders. SSA recommends shipments based on the order of sources
Deleting Stocks
When you delete the stock, all assigned web sites are assigned to the Default Stock. We
recommend reassigning websites to other stocks prior to deletion.
Important: Deleting a stock can affect salable quantities and unprocessed orders for a sales
channel. If you continue using a sales channel, please add the sales channel to another existing or
new stock.
1. On the Admin sidebar, tap Stores. Then under Inventory, choose Stocks.
2. Select one or more stocks you want to delete. Browse or search and select checkboxes for stocks
you want to delete.
4. A verification displays. Tap OK. The stock is deleted and any assigned sales channels are
unmapped.
When creating new products, assign sources and quantities during product creation. See
Product Types documentation for full instructions. These pages includes Single and Multi
Source information for sources and quantities per source.
When first accessing an upgraded Magento with Inventory Management, all products and
quantities are assigned to the Default Source. When importing new products via .csv file, they
are also assigned to the Default Source.
Single and Multi Source merchants can update sources, inventory quantities, and thresholds
per product or in bulk.
l Single Source merchants can update product quantities for the Default Source; this is the
total amount of products available for sale.
l Multi Source merchants can assign multiple sources and quantities per product for each
location (warehouses, stores, drop shippers, etc). We recommend having Sources added
prior to setting product inventory amounts.
When adding sources and quantities to your products, you can view the amounts through the
Product Grid. If you have a high number of sources, hover the Quantity per Source to see the
full, scrollable list of sources with current quantities.
Important: Unassigning a source clears all quantity data. Reassigning a source with quantity data can
potentially cause issues with pending orders with reservations and affect stock salable quantity counts.
Keep in mind, all product quantities in shopping carts and submitted orders have associated
reservations. If you unassign the only sources providing those products to the stock, orders cannot be
completed and shipped for that sales channel.
Recommendation: We recommend processing all pending orders and sending shipments prior to
removing sources or transferring all inventory.
To assign sources:
1. On the Admin sidebar, tap Catalog. Then, choose Products.
3. Expand the Sources section. This section allows you to modify the source, update
inventory quantities, and more.
Currently, only Simple, Configurable, Virtual, Downloadable, and Grouped products support
multiple sources. Bundle products can be created and managed with only the Default Source and
Stock.
4. To add a source, tap Assign Sources. The Assign Sources page displays.
5. Browse or search for a source you want to add. Select the checkbox next to the source(s) you
want to add for the product.
l Tap Save .
After assigning sources, update the inventory quantity for each product source.
To hide a source's inventory from shipments without removing the source, select Out of Stock
for Source Item Status. The SSA and shipment options only access sources listed as In Stock
with available inventory quantity.
To update quantities:
1. On the Admin sidebar, tap Catalog. Then, choose Products.
a. For a Source, Set Source Status to "In Stock". To see the source code, hover over the name.
Custom Notify Quantity Clear the Use Default checkbox and enter an amount
in Notify Qty.
Default Notify Quantity Select the Use Default checkbox. Magento checks and
uses the setting in Advanced Inventory or global Store
configuration.
l Tap Save .
The Product Grid updates with a list of all sources and related quantities. For products with
more than five assigned sources, hover over the Quantity per Source column to see the full list.
After adding new custom sources, you can add inventory quantities per product or for multiple
products through the Admin or using the import feature.
To update quantities:
1. On the Admin sidebar, tap Catalog. Then, choose Products.
2. Select the products you want to modify sources. Browse or search to find the products and
select those checkboxes.
3. Tap the Actions drop-down menu, and choose Assign Inventory Source. Tap OK to verify.
4. Select checkboxes for all sources you want to add to the products.
Important: Unassigning a source clears all quantity data. Reassigning a source with quantity data can
potentially cause issues with pending orders with reservations and affect stock salable quantity counts.
Keep in mind, all product quantities in shopping carts and submitted orders have associated
reservations. If you unassign the only sources providing those products to the stock, orders cannot be
completed and shipped for that sales channel.
Recommendation: We recommend processing all pending orders and sending shipments prior to
removing sources or transferring all inventory.
We strongly recommend completing all orders and shipments for those products prior to
removing the source.
To update quantities:
1. On the Admin sidebar, tap Catalog. Then, choose Products.
2. Select the products you want to modify sources. Browse or search to find the products and
select those checkboxes.
3. Tap the Actions drop-down menu, and choose Unassign Inventory Source. Tap OK to verify.
5. Tap Unassign Sources. An alert displays that unassigning will remove all specific source and
quantity data from the product.
This option allows you to select one or more products, the origin source to transfer inventory,
and the destination source to receive quantities:
l Inventory quantities, Source Item Status (In Stock/Out of Stock), and the Notify Quantity
for the selected source are moved per product.
l All product inventory for the source is moved. You cannot transfer a partial quantity.
Important: If the origin and destination sources are in different stocks, this will affect the
aggregated Salable Quantity and reservations for in-progress orders.
You have an option to also unassign the source when transferring inventory quantities.
Important: Unassigning a source clears all quantity data. Reassigning a source with quantity data can
potentially cause issues with pending orders with reservations and affect stock salable quantity counts.
Keep in mind, all product quantities in shopping carts and submitted orders have associated
reservations. If you unassign the only sources providing those products to the stock, orders cannot be
completed and shipped for that sales channel.
Recommendation: We recommend processing all pending orders and sending shipments prior to
removing sources or transferring all inventory.
2. Select the products you want to modify sources. Browse or search to find products and select
checkboxes for transfer.
3. Tap the Actions drop-down menu, and choose Transfer Inventory to Source. Tap OK to verify.
4. Select the origin source to transfer products to a new destination. Tap Continue.
6. To remove the source from the products, select the optional checkbox Unassign from origin
source after transfer.
7. Tap Inventory Transfer. All product quantities are deducted from the origin source and added
to the destination source. The Quantity and Salable Quantity automatically update.
l Magento automatically assigns the Default Source to your products when upgrading
Magento or importing new products. If you import products with a custom source assigned,
the Default Source will still be added with a quantity of 0. To update sources and quantities,
use these import instructions.
l Single Source merchants use import to update only product quantities. All existing and
added products are assigned to the Default Source.
l Multi Source merchants use import to add multiple sources and quantities per row per SKU.
To import updates, first export a CSV file for a specific or all sources. Edit the CSV file and add
a row per SKU for each source and quantity. You need the source's code when adding a new
source and adding quantities of stock. You cannot add or update stocks using import-export
features.
l source_code: The code for sources in Magento. You will see a row for each source and SKU.
l sku: The SKU for the product in Magento. The SKU must match a product in your store to
properly update Inventory Management data.
l status: 0 for Out of Stock. 1 for In Stock. This value must be 1 to purchase stock from this
source.
l quantity: The total amount of inventory available for this SKU and source.
Use this option to quickly update multiple products and assigned sources to update and
correct any inaccuracies in inventory records rather than one at a time through the application
interface. For a base file, export first and update as needed.
1. On the Admin sidebar, tap System. Under Data Transfer, choose Export.
2. From the Entity Type drop-down menu, select Stock Sources. The export only extracts data
for products with a SKU.
3. Tap Continue. The file generates and downloads to open and edit.
After updating inventory amounts and product data, import the file back into Magento.
1. On the Admin sidebar, tap System. Under Data Transfer, choose Export.
2. From the Entity Type drop-down menu, select Stock Sources. The export only extracts data
for products with a SKU.
3. To filter the exported products for a specific source, scroll to the Entity Attributes. For
source_code, enter the code for the source in the filter field.
4. Tap Continue. The file generates and downloads to open and edit.
After updating inventory amounts and product data, import the file back into Magento.
1. On the Admin sidebar, tap System. Under Data Transfer, choose Import.
2. From the Entity Type drop-down menu, select Stock Sources. The export only extracts data
for products with a SKU.
This information includes specifics for Inventory Management. For additional information, see
the Orders section.
Orders
Magento supports single orders and multiaddress orders out-of-the-box without additional
configurations. As customers or your staff enter orders, Inventory Management tracks inventory
using reservations against the salable quantity, deducting from inventory quantity when
invoicing and shipping the products.
Multiaddress Orders
For multiaddress orders, a series of single orders are generated, one for each destination
address entered. During checkout, customers select each set of products associated per address
during checkout generates as single orders according to the destination address. Each order
includes the products associated per address.
Magento manages inventory for these multiaddress orders exactly like single orders, allowing
for Source Selection Algorithm recommendations or overrides during shipment, partial
shipments, canceling orders, and refunding with stock updates.
Multiaddress at Checkout
Refunds
When entering a credit memo to issue a refund, you have an option to return the product
quantity to the deducted source. The order information includes the inventory source that
shipped the product. We recommend awarding the returned product quantity through a credit
memo when you receive the returned product.
If an order has not been shipped and is canceled (in full or partial), Inventory Management
automatically returns the product stock to the salable quantity. Until invoice and shipping,
purchased products are reserved against the salable quantity, not deducted from the actual
quantity. Invoicing and shipping converts the reservation to an inventory deduction.
Shipments
With Magento Inventory Management enabled, you can send partial or complete shipments
from one or more sources to fulfill orders. You control your outgoing inventory for each order,
setting the amounts to deduct, sending one or more shipments, and delivering in stock and
backorders as inventory is available. For each line item in the order, enter an amount to deduct
from the source quantity. Generate a shipment per source as you have inventory stock, until
the entire order is fulfilled.
Partial Shipments
For Multi Source merchants, Magento generates a shipment for every source you select. The
general workflow allows you to select a source, set the products quantity to deduct to fulfill the
order, and proceed to shipment. When complete, create additional shipments for each source
until you have fulfilled the order.
Single Source merchants may also send partial shipments to support backorders or balance
inventory as orders come in for popular items.
The Source Selection Algorithm provides recommendations for partial and full shipments. You
can access Source Selection Algorithms when creating shipment invoices for an order. Through
the Ship page, run the Source Priority or Distance Priority algorithm at any time to determine
the best options for matching ordered quantities and available sources. The system supports
shipping a complete order from one source, and breaking the order into multiple partial
shipments across multiple sources. You can access these options for immediate fulfillment and
staggered shipments to send smaller amounts over a period of time.
To complete and ship an order, it must have completed payment and be invoiced. At this time,
you can rerun the SSA for recommendations and ship from one or more sources, or override the
SSA recommendations with manually set sources and quantities to fulfill shipment.
l If you want to change the selections, you can override with manual source deductions.
As shipments generate, reservations for products clear and product quantity is deducted. The
on-hand quantity per stock updates based on the shipment details. For example, if you send
shipments for 10 products from two sources, the quantities for those sources deduct 10 each.
The Salable Quantity automatically refreshes for associated stocks, providing customers and
staff with the latest product amounts. And the reservations clear completely, no longer
counting against the Salable Quantity.
Developer options: If you want to review reservations, a series of command line options are
available. You can only review reservations through a command line interface. Using CLI
commands may require developer assistance. See Inventory Management CLI Reference.
With Inventory Management, send one or more shipments to fulfill as you have inventory.
Repeat these instructions to generate additional shipments as needed, using recommended or
manually entered quantities and sources. These instructions detail how Multi Source merchants
send shipments. Single Source merchants send shipments without these additional steps. See
Creating a Shipment.
When creating shipments, use the Source Selection Algorithm for calculated recommendations.
Follow and use these recommendations or set the amounts per source, generating custom
shipments. You control your outgoing inventory for each order, setting the amounts to deduct,
sending one or more shipments, and delivering in stock and backorders as inventory is
available. For each line item in the order, enter an amount to deduct from the source quantity.
As you enter shipments, your on-hand inventory quantities deduct entered amounts. In effect,
reservations convert to actual quantity deductions.
To create a shipment:
1. On the Admin sidebar, choose Sales. Then, choose Orders.
3. If the order has been paid and invoiced, and is ready to ship, tap Ship.
b. For the Select a Source to Ship from, select a source from the drop-down menu to send a
shipment.
c. For each line item, keep the recommended amount or enter a specific amount in the Qty to
Deduct.
5. Review the New Shipment page to enter any additional changes. The Inventory section displays
the source, products shipping, total ordered quantity, and quantity to ship.
Product Images
A single product image is rendered in different sizes throughout the catalog. The display size of
the image container on the page is defined in the style sheet of your theme. However, where the
image appears in your store 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.
If you intend to upload large images for viewing on the Product Details page, you may want to
consider setting a maximum pixel size (width and height) and automatically resizing the files
prior to upload. We provide an option to enable automatic resizing of significantly larger image
files as you upload. To learn more, see Resizing Product Images.
To manage images:
1. Open the product in edit mode.
2. To work with a specific store view, set the Store View chooser in the upper-left corner to the
applicable view.
3. 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 .
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.
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.
4. Tap the image that you want to open in detail view: Then, do any of the following:
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:
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
Hide Image
To exclude an image from the thumbnail gallery, mark the Hidden checkbox. Then, tap Save .
Hidden Images
5. To close detail view, click the Close ( ) box in the upper-right corner.
Image Roles
IMAGE ROLE DESCRIPTION
Thumbnail 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 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
Base Image 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. Depending on the level of zoom that you want to
achieve, the base image should be two or three times the size of the
container. Example sizes:
470 x 470 pixels (without Zoom)
1100 x 1100 pixels (with Zoom)
Setting a maximum pixel width and height resizes the image to the physical dimensions by
pixel. Magento resizes the image according to the higher amount of either width or height while
keeping the proportions. Reducing the quality amount for JPG images reduces the file size.
For example, a 3000 x 2100 pixel JPG at 100% could be a 5mb+ image. Resizing this image
would reduce the width to 1920 pixels, keeping proportions, and quality to 80% to provide
much smaller file size with high quality.
3. Expand the Images Upload Configuration section, and configure. TO change default
settings, you may need to clear the Use system value checkbox.
b. Enter a Quality setting from 1 to 100%. Recommend 80-90% for a reduced file size and
high quality.
c. Set the Maximum Width in pixels for the image. When the image is resized, it does not
exceed this width and retains proportions.
d. Set the Maximum Height in pixels for the image. When the image is resized, it does not
exceed this height and retains proportions.
Field Descriptions
Enable Frontend Resize Global Enable to allow Magento to resize large, oversized
images you may upload for the Product Details
Page. Magento resizing the image files using
JavaScript prior to uploading the file. When the
image is resized, it keeps the exact proportions,
meeting and not exceeding the largest size for
Maximum Width or Maximum Height.
Default: Yes
Maximum Width Global Determines the maximum pixel width for the
image. When the image is resized, it does not
exceed this width.
Default: 1920
Maximum Height Global Determines the maximum pixel height for the
image. When the image is resized, it does not
exceed this height.
Default: 1200
1. Log in to your Google account, and visit the Google Developers Console. Then, do the
following:
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.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
3. Expand the Product Video section. Then, paste your YouTube API key.
Product 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
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
New Video
Field Descriptions
FIELD DESCRIPTION
URL The URL of the associated video.
Preview Image An uploaded image that is used as a preview of the video in your
store.
Get Video Information Retrieves the video meta data that is stored on the host server. You
can use the original data, or update it as needed.
Role Determines how the preview image is used in your store. Options:
Base Image
Small Image
Thumbnail
Swatch Image
Hide from Product Page
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. For accessibility
controls, see Keyboard Navigation.
Media Gallery
Image Zoom
Customers can view a magnified portion of the image on mouseover, if the base 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
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
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.
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 file types 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: 50x50
Opacity: 5
Position: Tile
Tiled Watermark
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.
4. Complete the Base, Thumbnail, Small, and Swatch Image image settings as follows. The
fields in each section are the same.
c. Tap Upload, and choose the image file that you want to use.
6. When prompted to refresh the cache, tap the Cache Management link in the system message.
Then, refresh the invalid cache.
Refresh Cache
To delete a watermark:
Delete Watermark
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 .
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 configurable products, color can be indicated by a visual swatch, text swatch, or a drop-
down 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.
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.
Creating Swatches
Swatches can be defined as a component of the color attribute, or set up locally for a specific
product and uploaded as product images.
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.
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.
2. On the Admin sidebar, tap Stores. Then under Attributes, choose Product.
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:
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.
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.
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.
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:
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.
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.
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
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.”
Update Attributes
Change
5. Choose the swatch that applies to the selected products, and tap Save. Then when prompted,
refresh the cache.
Swatch in Storefront
Category Tree
Controls
FIELD DESCRIPTION
Collapse All / Expand All Either collapses or expands the category tree.
It’s important to clearly define categorical relationships such as parent category, sub
category, category path, and any associated keywords and attributes such as availability,
sale price, brand, size and color.
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 create as many additional subcategories as needed, according to themaximum
menu depth that is set in the configuration. 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.
For a website with multiple stores, you can create a different root category for each store that
defines the set of categories that is used for the top navigation.
Category Tree
Process Overview:
Step 1: Create a Category
Step 2: Complete the Basic Information
Step 3: Complete the Category Content
Step 4: Complete the Display Settings
Step 5: Complete the Search Engine Optimization Settings
Step 6: Choose the Products in Category
Step 7: Set Category Permissions
Step 8: Complete the Design Settings
1. On the Admin sidebar, tap Products. Then under Inventory, choose Categories.
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.”
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 top navigation, set Include in Menu to the “Yes” position.
Basic Information
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: Using the Editor.
4. To include a content block on the category landing page, choose the CMS Block that you want
to appear.
Content
l Products Only
3. If you want the category page to include the “Filter by Attribute” section of layered navigation,
set Anchor to the “Yes” position.
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 price step setting, do the following:
b. Enter the value to be used as an incremental price step for layered navigation.
Display Settings
l Meta Title
l Meta Keywords
l Meta Description
1. Expand the Products in Category section. Then, use one of the following methods to add
products to the category.
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.
Products In Category
a. For a multisite installation, choose the Website where the category permissions
apply.
b. Choose the Customer Group or Shared Catalog where the category permissions
apply.
l Browsing Category
l Add to Cart
2. To add another permission rule, tap New Permission. Then repeat the process.
Category Permissions
a. To change the design of the category pages, choose the Theme that you want to
apply.
b. To change the column layout of the category pages, choose the Layout that you want
to apply.
c. To enter custom code, enter valid XML code in the Layout Update XML box.
d. To use the same design for product pages, set Apply Design to Products to the “Yes”
position.
Design
2. When complete, tap Save.
Root Categories
The products in the main menu are determined by the root category that is assigned to the
store. The root category is basically a container for the main menu in the category tree. You can
create a root category with an entirely new set of products, or copy products from an existing
root category. The root category can be assigned to the current store, or to any other store in the
same website.
The following example shows how to create a new root category and assign it to a different
store.
Process Overview:
Step 1: Create a New Root Category
Step 2: Build Out the Main Menu
Step 3: Assign the Root Category to the Store
1. On the Admin sidebar, tap Products. Then under Inventory, choose Categories.
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:
b. Use the search filters to find the products you want. Then, mark the checkbox of each
product that you want to copy into the new catalog.
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 category structure for the
main menu.
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
store view.
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.
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.
2. In the category tree, select the category you want to hide. Then, do the following:
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:
As active categories, you can now link to them from other places in your store, but they will not
appear in the menu.
Modifying a Category
After a category is established, it can be edited, moved to another position in the category tree,
or deleted from the catalog. If your catalog is live, first consider how the change might impact
any existing links to products in the category. For example, if your product URLs include the
category path, and the category name is changed, any existing links to products in the category
will be broken. To avoid this problem, you can configure your catalog to automatically create a
permanent redirect if the URL key changes. You can also use the URL Rewrite tool to redirect
traffic from an old URL to a new one.
To move a category:
2. To move a category, drag-and-drop the category to a new position in the tree. Changes to the
category structure are saved automatically.
To delete a category:
3. In the category tree, select the category that you want to delete.
A deleted category cannot be restored, so make sure that you have selected the correct category
before proceeding.
Scheduled Changes
Category updates can be applied on schedule, and grouped with other content changes. You
can create a new campaign based on scheduled changes to the category, or apply the changes
to an existing campaign. To learn more, see: Content Staging.
Scheduled Changes
Content Settings
The Content settings determine any additional content appears on the category page. In
addition to the list of category products, the page can include an image, description, and
CMS block. You can use Page Builder’s advanced content tools to enter the category
description.
Category Content
Field Descriptions
FIELD SCOPE DESCRIPTION
Category Image Store View Specifies an image for the top of the category page.
Add CMS Block Store View Adds an existing CMS block to the category page.
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. For examples of how
categories are reflected in the storefront, see: Catalog Navigation.
Display Settings
Field Descriptions
FIELD DESCRIPTION
Display Mode Determines the content elements displayed on the category page.
Options:
Products Only
Static Block Only
Static Block and Products
Anchor When set to “Yes,” includes the “filter by attribute” section in the
layered navigation. Options: Yes / No
Available Product Listing (Required) The default values are Position, Name, and Price. To
Sort By 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.
Default Product Listing (Required) To define the default “Sort By” option, clear the “Use
Sort By Config Settings” checkbox and select an attribute.
Layered Navigation Price By default, Magento displays the price range in increments of 10,
Step 100, and 1000, depending on the products in the list. To change the
Price Step range, clear the “Use Config Settings” checkbox.
Field Descriptions
FIELD SCOPE DESCRIPTION
URL Key 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.
Meta Title 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 (SERP1). The meta title should be unique
to the page, and less than 70 characters in length.
Meta Keywords Store View Relevant keywords for the category Consider using
keywords that customers might use to find products in
the category.
Meta 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,
and allows you to use category rules to dynamically change the product selection when a set of
conditions is met.To learn more, see: Visual Merchandiser.
Category Products
Automatic Sort
To apply a sort order automatically to the list, based on current conditions, set Automatic
Sorting to one of the following:
Add Condition
When setting up a category rule, the products are matched and assigned to the rule when the
category is saved. Therefore, if you add a new product to the catalog and want to include it in the
rule, you must re-save each category that is set to match products by rule, to ensure that the new
product is included.
Field Definitions
OPTION DESCRIPTION
Match products by rule Determines if the list of products in the category is dynamically
generated by a category rule. Options: Yes / No
Automatic Sorting Automatically applies a sorting order to the list of category products.
Options:
None
Move low stock to top
Move low stock to bottom
Special price to top
Special price to bottom
Newest products first
Sort by color
Name: A - Z
Name: Z - A
SKU: Ascending
SKU: Descending
Price: High to Low
Price: Low to High
CONDITIONS
Attribute Determines the attribute that is used as the basis of the condition.
Options:
Operator Specifies the operator that is applied to the attribute value to meet the
condition. Unless an operator is specified, “Equal” is used as the
default. Options:
Equal
Not equal
Greater than
Greater than or equal to
Less than
Less than or equal to
Contains
Value Specifies the value the attribute must have to meet the condition.
Logic The Logic column is used to define multiple conditions, and appears
only when an additional condition is added. .Options:
OR / AND
Workspace Controls
CONTROL DESCRIPTION
View as List
View as Tiles
Match by Rule
The drag and drop control allows you to grab a product and move it to
another position in the current page of the grid. To learn more, see:
Visual Merchandiser.
You can set up the category options separately for each store view to determine the selection of
products, their relative position in the list, and the attributes that are available for category
rules.
Process Overview:
Step 1: Set the Scope of the Configuration
Step 2: Sort the Products
Step 3: Save, Refresh, and Verify
3. In the category tree on the left, choose the category that you want to edit.
Category Tree
1. In the Products in Category section, tap the tiles ( ) button to show the product tiles in a
grid. Then, use one of the following methods to sort the products:
Product Tiles
Sort Order
3. To save the sort order, tap Save Category.
Category Condition
l Contains
3. To add another condition, tap Add Condition and repreat the process.
2. When prompted to refresh the cache, click the Cache Management link and refresh each
invalid cache.
3. In the storefront, verify that the product selection, sorting, and category rules work correctly. If
you need to make adjustments, change the settings and try again.
Design Settings
The Design section gives you control over the look and feel of a category, all associated product
pages, and page layout. You can customize a category page and its associated products for a
promotion, or to differentiate the category. For example, you might develop a distinctive design
for a brand or special line of products, or apply an update for a specific period of time.
Design
Field Descriptions
FIELD DESCRIPTION
Use Parent Category Allows the current category to inherit the design settings from the
Settings parent category. If used, all other fields in the Design section become
unavailable. Options: Yes / No
Layout Update XML Updates the theme layout with custom XML code.
Apply Design to Products When selected, applies the custom settings to all products in the
category.
Category Permissions
Category access can be limited to specific customer groups, or restricted entirely. You can
control the display of product prices, and determine which customer groups can add products
to the cart, and specify the landing page.
Category Permissions has a global scope and when enabled, restricts access to each category
according to its individual permissions. By default, Category Permissions is not enabled.
For example, if you sell only to wholesale customers, you can allow anyone to browse the
catalog, but display prices and allow purchases only to those in the Wholesale customer group.
In the following example, ibnly logged in users have access to the “Collections” category. For
guests, the “Collections” option doesn’t appear in the main menu.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
Category Permissions
Browsing Category
The Allow Browsing Category setting applies to all categories in the website.
b. In the Customer Groups box, select each group that is allowed to browse through
products in the category. (For multiple options, hold down the Ctrl key, and click each
group.)
The Allow Browsing Category setting applies to all categories in the website. However, a
different Landing Page can be configured for each store view.
Product Prices
The Display Product Prices setting applies to all categories in the website.
To allow only members of specific customer groups to see the price of products in the
category, do the following:
b. In the Customer Groups box, select each group that is allowed to see the price of
products in the category. (For multiple options, hold down the Ctrl key, and click each
group.)
Add to Cart
The Add to Cart setting applies to all categories in the website.
To allow only members of specific customer groups to put category products into the
shopping cart, do the following:
b. In the Customer Groups box, select each group that is allowed to add products from the
category to the cart. (For multiple options, hold down the Ctrl key, and click each group.)
For Guests
To allow only logged in customers to use Catalog Search, select “NOT LOGGED IN”.
In the Disallow Catalog Search By box, select each group to be prevented from using
Category Search. (For multiple options, hold down the Ctrl key, and click each group.)
6. When prompted to update the cache, click the Cache Management link in the system message,
and follow the instructions to refresh the cache.
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 and attribute sets as necessary to describe the products in your catalog. In addition
to the attributes that you can create, system attributes, such as price, are built into the core
Magento platform and cannot be changed.
Process Overview:
Step 1: Describe the Basic Properties
Step 2: Describe the Advanced Properties
Step 3: Enter the Field Label
Step 4: Describe the Storefront Properties
1. On the Admin sidebar, tap Stores. Then under Attributes, choose Product.
Attribute Properties
4. Set Catalog Input Type for Store Owner to the type in input control to be used for data entry.
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.
6. If you want to require the customer to choose an option before the product can be purchased,
set Values Required to “Yes.”
Manage Options
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
Input Validation
5. To add this attribute to the product grid, set the following options to "Yes."
Add to Column Options Includes the attribute as a column in the Products grid.
Use in Filter Options Adds a filter control to the column header in the Products grid.
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
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.”
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.”
Storefront Properties
PROPERTY VALUE
Catalog Input Type for Store Owner Dropdown
Scope Global
Add Attribute
Process Overview:
Step 1: Add a New Attribute
Step 2: Describe the Basic Properties
Step 3: Describe the Advanced Properties
Step 4: Enter the Field Label
Step 5: Describe the Frontend Properties
1. Open the product in edit mode. Then in the upper-right corner, tap Add Attribute.
New Attribute
2. To add an existing attribute to the product, use the filter controls to find the attribute in the
grid. Then, do the following:
3. To define a new attribute, tap Create New Attribute, and complete the following steps.
2. Set Catalog Input Type for Store Owner to the type in input control to be used for data entry.
If the attribute is used for a configurable product, choose “Dropdown.” Then, set Required to
“Yes.”
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.
Values
4. If you want to require the customer to choose an option before the product can be purchased,
set Required to “Yes.”
2. Set Scope to indicate where in your store hierarchy the attribute can be used.
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 Email
l URL
l Letters
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.”
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
Storefront Properties
a. To make the attribute available for search, set Use in Search 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:
Filterable (with Layered navigation includes only those filters for which matching
results) products can be found. Any attribute value that already applies to
all products shown in the list does not appear as an available filter.
Attribute values with a count of zero (0) product matches are also
omitted from the list of available filters.
The filtered list of products includes only those that match the
filter. The products list is updated only if the selected filter(s)
change what is currently shown.
Filterable (no Layered navigation includes filters for all available attribute values
results) 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.”
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.”
Attribute Sets
One of the first steps when creating a product is to choose the attribute set that is used as a
template for the product record. The attribute set determines the fields that are available during
data entry, and the values that appear to the customer.
The attributes are organized into groups that determine where they appear in the product
record. Your store comes with an initial attribute set called “default” which includes a set of
commonly-used attributes. If you would like to add only a small number of attributes, you can
add them to the default attribute set. However, if you sell products that require specific types of
information, such as cameras, it might be better to create a dedicated attribute set that
includes the specific attributes that are needed to describe the product.
Attribute Sets
1. On the Admin sidebar, tap Stores. Then under Attributes, choose Attribute Set.
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.
The new group becomes a section of attributes in any product that is based on the attribute set.
Yes/No Displays a drop-down list with pre-defined options of “Yes” and “No.”
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 configurable
products.
Multiple Select Displays a drop-down list of values. To select more than one option,
hold the Ctrl key down and click each item.
Price 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.
Fixed Product Tax Lets you define FPT rates based on the requirements of your locale.
Visual Swatch Displays a swatch that depicts the color, texture, or pattern of a
configurable product. A visual swatch can be filled with a
hexadecimal color value, or display an uploaded image that
represents the color, material, texture, or pattern of the option.
Pop-up Calendar
2. In the panel on the left, tap Catalog. Then, choose the Catalog option.
4. To use a popup calendar as the input control for date fields, set Use JavaScript Calendar to
“Yes.”
l Month
l Day
l Year
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.
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.
Process Overview:
Step 1: Enable the Flat Catalog
Step 2: Verify the Results
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
a. Set Use Flat Catalog Category to “Yes.” If necessary, clear the Use system value
checkbox.
5. When prompted to update the cache, click the Cache Management link in the system message,
and follow the instructions to refresh the cache.
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:
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 Cron schedule.
2. In the upper-left corner, verify that Store View is set to “All Store Views.”
3. In the category tree, select an existing category. Then, tap Add Subcategory , and do the
following:
Test Subcategory
c. Expand the Products in Category section. Then, click Reset Filter to display all
products.
d. Mark the checkbox of several products to add them to the new category. Then, tap Save .
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.
If necessary, refresh the page to see the results. The change will appear within the minute or
according to your cron schedule.
Do the following to remove the test data and restore the original product name and catalog
configuration.
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.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
4. When complete, tap Save Config . Then when prompted, refresh the cache.
462
Contents
In this section of the guide, you’ll learn how to Marketing Menu
leverage your store's built-in shopping tools to
Shopping Tools
create opportunities for customer engagement,
and how to set up targeted promotions with price Opportunities to Engage
rules. Leverage multiple sales channels by Email a Friend
sending your product feeds to shopping sites Wish Lists
and marketplaces. Then, use Google tools to Product Relationships
analyze traffic, optimize your content, and plan
Compare Products
your next campaign.
Recently Viewed / Compared Products
Product Reviews
Promotions
Merchandising
Communications
SEO & Search
Google Tools
463
CHAPTER 20:
Marketing Menu
The Marketing menu provides access tools for managing promotions and private sales,
communications, SEO, user-generated content, and automated customer engagement.
Marketing Menu
Main Sections
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.
Create related product rules and manage gift card
accounts.
Private Sales
Private sales and other catalog events are a great way to
leverage your existing customer base to generate buzz
and new leads with exclusive access for members only,
or by invitation.
Communications
Customize all notifications sent from your store. Create
newsletters and publish RSS feeds.Set up rules that
send email reminders to customers whenever the
conditions are met.
User Content
Leverage user-generated product reviews to create a
sense of community, and increase sales.
Customer Engagement
Create personalized, automated engagement campaigns
that exceed customer expectations. Connect your data
to boost ROI, and increase customer lifetime value.
Product Page
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.
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
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
Email Templates
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 Guests 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:
Cookie (unsafe) Identifies the sender by browser cookie. This method is less
effective because the sender can delete the cookie to bypass
the limit.
1. On a catalog page, click the Email a Friend link. Then, do one of the following:
2. Complete the Message and enter the recipient Name and Email Address. To add more
recipients, do the following:
You can send the message to as many additional people as the configuration allows.
Wish Lists
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 in the sidebar of category and product pages. Depending on the theme, it might be a
text link or a graphic image. If you prefer not to show customer wish lists in the side bar, they
can be hidden from view in the configuration.
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 customer account, Items can be added or
transferred between the wish list and cart by the customer or by the store administrator.
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.
b. To allow customers to maintain more than one wish list, set Enable Multiple Wish Lists
to “Yes.”
c. If applicable, enter the Number of Multiple Wish Lists that each customer can maintain.
d. By default, a customer’s wish lists appear in the sidebar of storefront pages. If you prefer
to hide the wish lists, set Show in Sidebar to “No.”
General Options
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.
5. Expand the My Wish Lists Link section. Then, set Display Wish Lists Summary to one of
the following:
1. Log in to your customer account. Then in the panel on the left, choose My Wish List.
2. Find the item you want to edit in the wish list, and do any of the following:
l Add a comment.
l Add to Cart
2. Find the customer in the list. Then in the Action column, click Edit.
3. In the panel on the left, choose Wish List. Then, find the item to be edited in the list. Any
options selected for the product appear below the product name.
b. Click Configure.
1. In the panel on the left of your customer account dashboard, choose My Wish List.
2. To add a comment to an item, hover over the image, and enter your Comment in the box.
4. When you’re ready to send the message, tap Share Wish List.
a. Hover over the item., and enter the Qty that you want to add to the cart.
2. To transfer all wish list items to the cart, tap Add All to Cart.
2. In the upper-right corner, tap Add Widget. Then, in the Settings section, do the following:
b. Set Design Package/Theme to the theme of the store where the wishlist will be added.
d. Set Assign to Store Views to the view or website where the widget is to be used.
e. In the Layout Updates section, tap Add Layout Update. Then, specify where you want the
widget to appear.
Layout Update
3. In the panel on the left, choose Widget Options. Then, do the following:
Owner Name Customers can search for wish lists by owner name.
Owner Email Customers can search for wish lists by owner email address.
5. Configure the remaining widget properties as needed, following the standard instructions.
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.
Compare Products
Compare Products generates a detailed, side-by-side comparison of two or more products.
Depending on the theme, the Add to Compare link might be represented by an icon or text. The
Compare Products block usually appears in either the left or right sidebar of a catalog page.
Unlike the Recently Viewed / Compared Products block, the Admin does not include additional
configuration settings for Compare Products.
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.
4. After navigating to other pages, you can click the link in the header or sidebar to return to the
report.
l To remove all products from the report, click the Clear All link.
Compare 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.
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.
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.
Reviews Tab
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
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.”
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
Ratings
3. In the Rating Title section, enter the Default Value for the new rating. If applicable, enter the
translation for each store view.
Rating Title
4. In the Rating Visibility section, set Visibility In to the store view where the rating is to be used.
(Hold down the Ctrl key to select multiple options.)
5. In the Sort Order field, enter a number to determine the order of this rating when listed with
others.
Rating Visibility
491
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 Offer free shipping for purchases over a certain Example options for Catalog Price Rule
amount
Cart price rule conditions can be based on any
l Schedule a promotion for a period of time category that is a child of the store’s root. Price
rules are set up in advance, and spring into action
A rule is a collection of conditions (one or
whenever the required conditions are met. These
more) that apply changes in prices to products
rules use attributes including product attribute
when one or all are met. Each rule can have
combination like matching a SKU in the cart using
multiple conditions, applying when all or any
product attributes, product subselection like the
(one or more, but not all) statements are true
total quantity matching conditions, condition
or false.
combinations for complicated rules, and cart
Conditions are statements that refine the list of attributes like subtotal.
products and situations for applying the rule.
The attributes and options for conditions differ
between the types of available rules. When met,
the action is completed such as discounts, buy
one get one free (BOGO), and other options.
Rules can be simple or as complicated as need
to match your business needs, seasonal
discounts and promotions, and year long
opportunities. For example, you may want to Example options for Cart Price Rule
add a few more options for the holidays while
providing free shipping year-round when carts
Contents
have a high subtotal. In this section of the guide, you will learn how to
For catalog price rules, you build conditions set up product relationships, and use price rules to
based on attribute sets in your catalog, trigger discounts based on a variety of conditions.
comparison functions, and selected attributes.
You create the conditions like sentences by
selecting a few statements. For example, you
may create two price rules to apply discounts
Catalog Price Rules
for childrens clothing and mens/womens
clothing based on the category. Multiple SKUs
Coupon Codes
Coupon Report
492
Free Shipping Promotion
Buy X Get Y Free
Discount with Minimum Purchase
493
CHAPTER 22:
Catalog Price Rules
Catalog price rules can be used to offer products to buyers at a discounted price, based on a set
of defined conditions. Catalog price rules do not use coupon codes, because they are triggered
before a product is placed into the shopping cart.
For example, you can define and set the conditions for a price rule that when met,
automatically display products with a special or promotional price. Defined rule properties
might include customer groups, product categories, a discount amount or percentage, product
color, product size, or just about any product attribute set up in your store. You can set start
and end dates for a price rule that automatically start and stop a promotion on the dates you
define in the rule. You can also link a defined rule to a dynamic block to help promote the event
or product in your store. The properties of a saved rule can be updated or modified as needed.
Catalog Rules
If you have many rules created, you can filter the list by using the filter options at the top of
each column. Complete your filter options and tap Search to narrow your list. To clear all filter
options and display the complete list, tap Reset Filter.
Filter Options
FIELD DESCRIPTION
ID Free-text field that filters the list for a specific rule ID number.
Rule Free-text field that filters the list based on the rule name defined when
the rule was created.
Priority Free-text field that filters the list based on the priority defined for a
rule.
Website Drop-down field that filters the list based on websites defined for a
rule.
Action Click Edit to display the Rule Information screen and update the
rule's settings (similar to creating a new rule).
Process Overview:
Step 1: Add a New Rule
Step 2: Define the Conditions
Step 3: Define the Actions
Step 4: Add Related Dynamic Blocks (Optional)
Step 5: Schedule the Rule
Step 6: Save and Test the Rule
1. On the Admin sidebar, tap Marketing. Then under Promotions, choose Catalog Price Rule.
The Rule Information section displays, with expandable sections for Conditions and Actions.
Rule Information
a. Complete the Rule Name and Description fields. These fields are for your internal
reference only.
To choose multiple groups, hold down the Ctrl key (PC) or the Command key (Mac), and
click each option.
The options in this list is dependent on the customer groups created and managed in the Admin
> Customers > Customer Groups section.
d. Enter a number to establish the Priority of this rule in relation to other rules.
The Priority setting is important when the same catalog product meet the conditions set for
more than one price rule. The rule with the highest Priority setting (1 being the highest) will
become active for the product.
Most of the available conditions are based on existing attribute values. To apply the rule to all
products, leave the conditions blank.
1. Scroll down and expand the Conditions 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.
You can create different conditions by changing the combination of these values. For this
example, the following condition is used:
2. Tap the Add ( ) button at the beginning of the next line. Select an option for the condition,
such as a product attribute or combination.
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.”
For an attribute to appear in the list, it must be configured to be used in promo rule conditions.
To learn more, see: Product Attributes.
The selected condition appears in the statement, followed by two more bold links. The
options differ depending on the condition attribute you select. The statement now says:
Attribute Set is …
b. Tap the is link, and choose the comparison operator that describes the condition to be
met. These options may include option for different comparisons such as matching values,
not including or including at least one of a value, and great than, equal to, and less than a
numerical amount. In this example, the options are “is” and “is not.”
c. Select or enter values for the condition. Depending on the condition, you may select
products from a grid or list, enter a numerical value, and so on. For this example, tap the
(... ) “more” link, and choose the attribute set upon which the condition is based.
3. To add another condition line to the statement, tap the Add ( ) button, and choose one of the
following:
l Conditions Combination
l Product Attribute
Then, repeat the process until all desired conditions are complete.
If at any time you want to delete part of the condition statement, tap the Delete ( ) button
at the end of the line.
Actions
Apply as fixed Discounts item by subtracting a fixed amount from the regular price. For
amount example:
Enter 10 in Discount Amount for a final price that is $10 less than the
regular price.
Adjust final price Adjusts the final price by a percentage of the regular price. For example:
to this percentage Enter 50 in Discount Amount for a final price that is marked down 50%
from the regular price.
Adjust final price Sets the final price to a fixed, discounted amount. For example:
to discount value Enter 20 in Discount Amount for a final price of $20.00.
*Regular price refers to the base product price without any advanced
pricing (special/tier/group) or promotional discounts.
**Final price refers to the discounted price that appears in the shopping
cart.
4. To stop processing other rules after this rule is applied, set Discard Subsequent Rules to
“Yes.”
Setting this to "Yes" safeguard prevents the system from applying multiple discounts (rules) to the
same product.
2. Use the search filters to locate the dynamic block(s) that you want to associate with the rule.
3. Mark the checkbox in the first column to associate the dynamic block with the rule.
Scheduled Changes
You can either edit the existing update or assign the catalog price rule to another campaign.
The Edit Existing Update option is selected by default.
3. To schedule the rule, enter the Start Date and End Date that the price rule is to be active. You
can either enter the dates or choose the dates from the Calendar ( ).
Update Schedule
Price rules are automatically processed with other system rules each night. When you create a
new price rule, allow enough time for it to get into the system. Then, test the rule to make sure
that it works correctly. As new rules are added, Magento recalculates the prices and the
priorities accordingly.
Field Descriptions
FIELD DESCRIPTION
RULE INFORMATION
Rule Name (Required) The name of the rule is for internal reference.
Description A description of the rule should include the purpose of the rule, and
explain how it is used.
Websites (Required) Identifies the websites where the rule can be used.
Customer Groups (Required) Identifies the customer groups to which the rule applies.
Priority A number that indicates the priority of this rule in relation to others.
The highest priority is number 1.
CONDITIONS
Specifies the conditions that must be met before the catalog price
rule goes into action. If left blank, the rule applies to all products.
ACTIONS
Identifies any dynamic block(s) that are associated with the rule.
If there are multiple price rules running in the same campaign, the Priority setting of the price
rule determines which rule takes precedence. To learn more, see: Content Staging.
If a campaign that includes a price rule is initially created without an end date, the campaign cannot
later be edited to include an end date. It is recommended that you either add an end date when you
create the campaign, or create a duplicate version of the existing campaign and add the end date to
the duplicate as needed.
Scheduled Changes
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.
4. In the panel on the left, choose Storefront Properties. Then, make sure that Use for Promo
Rule Conditions is set to "Yes."
1. On the Admin sidebar, tap Marketing. Then under Promotions, choose Cart Price Rules.
b. Tap Add ( ) at the beginning of the next line. Then, in the list under Product Attribute,
choose SKU.
SKU is one of …
c. For the comparison, you have options. If you want to locate at least one from a list of
SKUs, select is one of. If you want to locate a group of SKUs that all must be found to
apply, select is. We recommend selecting is one of.
d. To complete the condition, click the (…) “more” link. Then, tap the Chooser button for the
list of available products.
e. Browse, filter, or search to find the SKUs you want to add. 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.
4. Complete the rule, including any Actions to be taken when the conditions are met.
Price rules are automatically processed with other system rules each night. When you create a
new price rule, allow enough time for it to get into the system. Then, test the rule to make sure
that it works correctly.
Filter Options
FIELD DESCRIPTION
ID Free-text field that filters the list for a specific rule ID number.
Rule Free-text field that filters the list based on the rule name defined when
the rule was created.
Coupon Code Free-text field that filters the list based on the code name defined
when the rule was created.
Priority Free-text field that filters the list based on the priority defined for a
rule.
Status Drop-down field that filters the list based on rule status, Active or
Inactive.
Website Drop-down field that filters the list based on websites defined for a
rule.
Action Click Edit to display the Rule Information screen and update the
rule's settings (similar to creating a new rule).
Process Overview:
Step 1: Add a New Rule
Step 2: Describe the Conditions
Step 3: Define the Actions
Step 4: Complete the Labels
Step 5: Add Related Banners
1. On the Admin sidebar, tap Marketing. Then under Promotions, choose Cart Price Rules.
b. If you do not want the rule to go into effect immediately, set Active to “No.”
Rule Information
l If you want the promotion to be available only to registered customers, do not choose
the “NOT LOGGED IN” option.
4. To have the cart rule applied to all cart items, set Coupon to "No Coupon" and skip to step 5.
To associate a coupon with a price rule, set Coupon to “Specific Coupon.” Then, do the
following:
Coupon Settings
a. Enter a free-text 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:
Uses per Coupon Determines how many times the coupon code can be used.
If there is no limit, leave the field blank.
Uses per Customer Determines how many times the coupon code can be used
by the same registered customer who belongs to any of the
selected customer groups. The setting does not apply to
guest shoppers who are members of the NOT LOGGED IN
customer group, or to customers who shop without logging
in to their accounts. If there is no limit, leave the field
blank.
5. To set a limit on the number of times the coupon can be used, complete the following:
Uses per Customer Determines how many times the coupon code can be used by the
same registered customer who belongs to any of the selected
customer groups. The setting does not apply to guest shoppers
who are members of the NOT LOGGED IN customer group, or to
customers who shop without logging in to their accounts. If
there is no limit, leave the field blank.
6. Enter a number to define the Priority of this price rule in relation to the Action settings of other
price rules which are active at the same time.
The Priority setting is important when two cart rules/coupon codes are valid for the same product at
the same time. The rule with the highest Priority setting (1 being the highest) will control the cart
action.
7. To apply the rule to published RSS feeds, set Public In RSS Feed to “Yes.”
8. This is a good time to save your work. Tap Save and Continue Edit.
After the rule is saved, the name of the cart price rule and the Scheduled Changes box appears
at the top of the page.
Scheduled Changes
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:
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:
2. Click Add ( ) at the beginning of the next line. Select an option for the condition, such as
cart attribute, product subselection, or combination. For this example, complete the next part
of the condition as follows:
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.
c. Click the "more" (...) link, and enter ">100." This condition requires the total quantity of
the cart to be greater than 100.
3. Click Add ( ) at the beginning of the next line. Then add a condition that is based on
Category.
Category
a. In the next part of the condition, click the "more" (...) link to display the input field.
Then, open the Chooser ( ) to display the category tree.
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 root category.
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:
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
To base the condition on shopping cart totals, use one of the following cart attributes:
l Subtotal
l Total Weight
The shopping cart price rule actions describe how prices are updated when the conditions are
met.
1. Scroll down to Actions, and expand the section. Then, do the following:
Fixed amount discount Discounts item by subtracting a fixed amount from the
original price of each qualifying item in the cart.
For example: Enter 10 in Discount Amount for an updated
price that is $10 less than the original price.
Fixed amount discount Discounts the entire cart by subtracting a fixed amount
for whole cart from the cart total.
For example: Enter 10 in Discount Amount to subtract $10
from the cart total.
By default, the discount applies only to the cart subtotal. To
apply the discount to the subtotal and shipping separately,
see Apply to Shipping Amount.
Buy X get Y free 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.
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 determine if free shipping is applied to orders that meet the conditions, set Free
Shipping to one of the following:
For matching items only Free shipping is available only for items that match the
conditions of the rule.
For shipment with Free shipping is available for any shipment that includes
matching items matching item(s).
h. In the Add Rewards Points field, enter the number of points the customer earns whenever
the cart price rule is applied. (If reward points aren’t enabled, leave this field blank.)
The label appears in the totals section of the order to identify the discount. The label text is
enclosed in parentheses, after the word, “Discount”. You can enter a default label for all store
views, or enter a different label for each view.
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.
2. Use the search filters to locate the banner(s) that you want to associate with the rule.
3. Mark the checkbox in the first column to associate the banner with the rule.
Price rules are automatically processed with other system rules each night. When you create a
new price rule, allow enough time for it to get into the system. Then, test the rule to make sure
that it works correctly. As new rules are added, Magento recalculates the prices and the
priorities accordingly.
Field Descriptions
FIELD DESCRIPTION
RULE INFORMATION
Rule Name (Required) The name of the rule is for internal reference.
Description A description of the rule should include the purpose of the rule, and
explain how it is used.
Websites (Required) Identifies the websites where the rule can be used.
Customer Groups (Required) Identifies the customer groups to which the rule applies.
Uses per Customer Determines how many times the coupon code can be used by the
same registered customer who belongs to any selected customer
group. Does not apply to guest shoppers who are members of the
NOT LOGGED IN customer group, or to customers who shop
without logging in to their accounts. For no limit, leave blank.
Priority A number that indicates the priority of this rule in relation to others.
The highest priority is number 1.
CONDITIONS
Specifies the conditions that must be met before the cart price rule
goes into action. If left blank, the rule applies to all products in the
cart.
ACTIONS
Maximum Qty Discount is Sets the maximum number of products that the discount can be
Applied To applied to in the same purchase.
Apply to Shipping Amount Determines if the discount can be applied to the cost of shipping.
Options:
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:
For shipment with Free shipping is available for the entire cart
matching items when a coupon that is based on the rule is
used.
Add Reward Points Specifies the number of reward points that are earned by the
customer whenever the price rule is applied.
LABELS
Default Rule Label for All A default label that identifies the discount and can be used for all
Store Views store views.
Store View Specific Labels If applicable, specifies a different label to identify the discount for
each store view.
RELATED BANNERS
Coupon Codes
Coupons codes are used with cart price rules to apply a discount when a set of conditions is
met. For example, a coupon code can be created for a specific customer group, or for anyone
who makes a purchase over a certain amount. To apply the coupon to a purchase, the customer
can enter the coupon code in the cart, or possibly at the cash register of your “brick and mortar”
store. Here are a few ways that you can use coupons in your store:
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.
b. To limit the number of times the coupon can be used, complete the following:
Coupon Information
3. To make the coupon valid for a period of time, do one of the following:
1. Tap Schedule New Update in the upper-right corner of the page. Then, do the following:
Schedule Update
2. Enter the Update Name and Description.
3. Choose the Start Date and End Date from the Calendar ( ). If you leave the date range
empty, the rule will not expire.
Scheduled Change
3. To limit the number of times each customer can use the coupon, enter the number of Uses per
Customer.
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.
l Alphanumeric
l Alphabetical
l Numeric
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
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.
Coupons Report
The Coupons Report can be filtered for a specific store view, time period, order status, and price
rule.
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 statistics for the day, click the message at the top of the workspace.
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
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 order status, 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.”
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.
If a campaign that includes a price rule is initially created without an end date, the campaign cannot
later be edited to include an end date. It is recommended that you either add an end date when you
create the campaign, or create a duplicate version of the existing campaign and add the end date to
the duplicate as needed.
If there are multiple price rules running in the same campaign, the Priority setting of the price
rule determines which rule takes precedence. To learn more, see: Content Staging.
Scheduled Changes
Some shipping carrier configurations give you the ability of offer free shipping based on a
minimum order. To expand upon this basic capability, you can use shopping cart price rules to
create complex conditions based on multiple product attributes, cart contents, and customer
groups.
Process Overview:
Step 1: Enable Free Shipping
Step 2: Create a Cart Price Rule
Step 3: Complete the Labels
Step 4: Save and Test the Rule
2. Complete the free shipping settings for any carrier service that you want to use for free
shipping.
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.
d. In the Websites box, select each site where the free shipping coupon is to be
available.
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 coupon.
2. Scroll down and expand the Actions section. Then, do the following:
c. Click the (…) “more” link, and enter a threshold value for the Subtotal, such as 100,
to complete the condition.
Condition
Actions
Price rules are automatically processed with other system rules each night. When you create a
new price rule, allow enough time for it to get into the system. Then, test the rule to make sure
that it works correctly.
Process Overview:
Step 1: Create a Cart Price Rule
Step 2: Define the Conditions
Step 3: Define the Actions
Step 4: Complete the Label
Step 5: Save and Test the Rule
Complete Step 1 of the cart price rule instructions to complete the rule information.
Complete Step 2 of the cart instructions to define the conditions for the price rule. This is the
first of two conditions that can be added to the rule, and determines when the rule is triggered.
It can be based upon a combination of product attributes, products, cart attributes, and
customer segments. If left blank, the rule is triggered for every cart.
Condition
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 three.
e. If you want to prevent other discounts from being applied to the purchase, set Discard
subsequent rules to "Yes."
2. To apply the rule only to specific items in the cart, complete the condition to describe the cart
item(s) and/or product attribute(s) that are required for the promotion. The following example
uses the SKU to apply the rule to all associated variations of a configurable product.
4. Tap Save and Continue Edit. Then, complete the rest of the rule as needed.
Price rules are automatically processed with other system rules each night. When you create a
new price rule, allow enough time for it to get into the system. Then, test the rule to make sure
that it works correctly.
Examples
Buy X Get Y Free is processed as a single action, with a “row total” dependency. All items must
be from the same SKU to qualify for the promotion. For example:
Buy X quantity of product from category A, get Y quantity of the same product
for free.
To limit the free product to categories A, B, and C, set the action as follows:
Category is one of A, B, C
To limit the free items from any category A, B, C and receive Y from SKUs D123, E123, F123, set
the action as follows:
Use the following formula to determine the correct value for the Maximum Qty Discount:
Where
For example:
Where
X = 5
Y = 2
M = 4
Where
X = 5
Y = 3
M = 9
Where
X = 20
Y = 2
M = 20
Process Overview:
Step 1: Create a Shopping Cart Rule
Step 2: Define the Conditions
Step 3: Define the Actions
Step 4: Apply the Labels
Step 5: Save and Test the Rule
3. Tap Add ( ) at the beginning of the next line. Then in the list under Product Attribute,
choose Category.
Category
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:
Category IS
b. Click the (...) “more” link and enter the amount that the Price in Cart must be to meet the
condition. For example, enter 200.
Actions
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.
Price rules are automatically processed with other system rules each night. When you create a
new price rule, allow enough time for it to get into the system. Then, test the rule to make sure
that it works correctly.
For an attribute to be used in a targeted rule, the Use for Promo Rule Conditions property must be
set to “Yes.”
Rule Information
a. Enter a Rule Name to identify the rule when working in the Admin.
b. In the Priority field, enter a number that determine the order that the results appear on
the page, when results from other rules target the same location. Number 1 is top priority.
l Related Products
l Up-sells
l Cross-sells
e. If the rule is to be active for a specific range of time, enter the From and To dates.
f. In the Result Limit field, enter the number of records to appear in the results list. The
maximum number is 20.
g. If the rule applies to a specific customer segment, set Customer Segments to “Specified.”
Then, choose the customer segment from the list.
4. In the panel on the left, choose Products to Match. Then, build the condition as you would for
a catalog price rule.
Products to Match
5. In the panel on the left, choose Products to Display. Then, build the results condition as you
would for a catalog price rule.
Products to Display
6. Complete the condition to describe the products that you want to include in the results.
Field Descriptions
FIELD DESCRIPTION
Rule Name A name that identifies the rule for internal use.
Priority Determines the sequence in which the results of the rule appear
when displayed with other sets of results that target the same place
on the page. The value can be set to any whole number, with the
highest priority of 1.
For example, if there are multiple up-sell rules that apply, the one with
the highest priority appears before the others. The sort order of the
products within each set of results is random.
Any up-sell, cross-sell, and related products that were manually
configured always appear on the page before any rule-based product
promotions.
Status Controls the active status of the rule. Options: Active / Inactive
Apply To Identifies the type of product relationship that is associated with the
rule. Options include:
Related Products
Up-sells
Cross-sells
From Date If the rule is active for a range of time, determines the first date the
rule is active.
To Date If the rule is active for a range of time, determines the last date the
rule is active.
Result Limit Determines the number of products that appear in the results at one
time. The maximum number is 20. If more matching results are
found, the products rotate through the block each time the page is
refreshed.
Customer Segments Identifies the customer segments to which the rule applies. Options:
All / Specified
The number of product IDs that can be included in a product relations rule is determined by
the Result Limit value, which has a maximum of twenty. The Result Limit value, combined
with the configurable maximum for the specific rule-based product promotion becomes the “real
limit,” and determines the actual number of matching products that can appear in the list.
For example, suppose you have three rules, with a priority of one, two, and three.
l There are two matching products returned for Rule 1, six matching products for Rule 2, and
twenty matching products for Rule 3.
l In the configuration, the Maximum Number of Products for Related Products List is set to
six.
Rule 2 2 6
Rule 3 3 20
If the first rule returns more matching products than allowed by the “configurable maximum
limit,” but less than the “real limit,” the matching products from the other existing rules are
used—in order of priority—until the “real limit” is reached.
By priority, the matching products returned from Rule 1 can be used first to fill all twenty-six
available slots. Because Rule 1 returned only two matching products, there is still room for
twenty-four more. Rule 2 has the next highest priority, and returns six more matching
products. There are now eighteen available slots to be filled. Rule 3 has the next level of
priority, with enough matching products to fill the remaining eighteen slots. When all available
slots are filled, and depending on the rotation mode that is set, the list might be shuffled, and
then reduced to the “configurable maximum limit.” In this case, the remaining six products
appear in the store.
l Selected Only
l Rule-Based Only
c. Set Rotation Mode for Products in Related Product List to one of the following:
l Do Not Rotate
l Shuffle
l Selected Only
l Rule-Based Only
c. Set Rotation Mode for Products in Cross-Sell Product List to one of the following:
l Do Not Rotate
l Shuffle
l Selected Only
l Rule-Based Only
c. Set Rotation Mode for Products in Upsell Product List to one of the following:
l Do Not Rotate
l Shuffle
549
Contents
Visual Merchandiser
Gift Registries
Gift Registry Workflow
Gift Registry Sections
Configuring Gift Registries
Setting up a Gift Registry
Gift Registry Search
550
CHAPTER 25:
Visual Merchandiser
Visual Merchandiser is a set of advanced tools that allows you to position products, and apply
conditions that determine which products appear in the category listing. The result can be a
dynamic selection of products that adjusts to changes in the catalog. You have the option to
work in “visual mode,” which shows each product as a tile on a grid, or to work from a list of
products in the category. The same tools are available in each mode, and you can use the
buttons in the upper-right corner to toggle between each type of display.
2. Drill down through the category tree, and click the category that you want to edit.
1. Use the sort order and paginate tools to view the product that you want to move.
In a clean installation, Magento reserves the category ID 2 for the root catalog of the default store.
Visual Merchandiser can use only categories with an ID number of 3 or greater.
Workspace Controls
CONTROL DESCRIPTION
View as List
View as Tiles
Match by Rule
Drag
Position
Go To Next / Previous
Each condition consists of an attribute, value, and logical operator. Only attributes with the
“Use in Product Listing” property set to “Yes” can be used in category rules. If you want to use
an attribute that is not included in product listings, open the attribute in edit mode, and set
“Use in Product Listing” to “Yes.” Although Date attributes are not supported, you can use the
Date Created or Date Modified attributes to define a date, or range of dates. For example, to
include only products that were created during the past week, set Date Created to a value of
“<7.”
Make sure to configure each attribute that is used in the rule as a “smart” attribute.
Use caution when applying a category product rule, because any products that do not meet the
condition are removed from the category. For example, if you create a rule that includes only purple
tank tops, all other tank tops are removed from the category.
1. For each attribute that is to be used in the rule, make sure that the “Use in Product Listing”
storefront property is set to “Yes”.
2. Complete the configuration to identify each “smart” attribute that is to be used with Visual
Merchandiser.
2. In the Products in Category section, set Match products by rule to the ”Yes” position.
4. Repeat this process for each attribute that is needed to describe the condition(s) to be met. For
example, to match products that were created between 7 and 30 days ago, do the following:
5. To apply a sort order automatically to the dynamically generated product list, set Automatic
Sorting to one of the following:
When setting up a category rule, the products are matched and assigned to the rule when the
category is saved. Therefore, if you add a new product to the catalog and want to include it in the
rule, you must re-save each category that is set to match products by rule, to ensure that the new
product is included.
Menu Options
OPTION DESCRIPTION
Match products by rule Determines if the list of products in the category is dynamically
generated by a category rule. Options: Yes / No
Automatic Sorting Automatically applies a sorting order to the list of category products.
Options:
None
Move low stock to top
Move low stock to bottom
Special price to top
Special price to bottom
Newest products first
Sort by color
Name: A - Z
Name: Z - A
SKU: Ascending
SKU: Descending
Price: High to Low
Price: Low to High
CONDITIONS
Attribute Determines the attribute that is used as the basis of the condition.
Options:
Operator Specifies the operator that is applied to the attribute value to meet the
condition. Unless an operator is specified, “Equal” is used as the
default. Options:
Equal
Not equal
Greater than
Greater than or equal to
Less than
Less than or equal to
Contains
Value Specifies the value the attribute must have to meet the condition.
Logic The Logic column is used to define multiple conditions, and appears
only when an additional condition is added. The operators follow the
rules of precedence for MySQL boolean operators. Options:
AND / OR
General Options
a. In the Attributes for Category Rules list, select each attribute that you want to make
available for visual merchandising. To choose multiple items, hold down the Ctrl key, and
click each item.
b. Enter the Minimum Stock Threshold for a product to appear in the Visual Merchandiser
window.
c. Enter the Color Attribute Code. The default value is color. If your catalog uses a different
attribute, enter the attribute name in lowercase.
d. In the Color Order box, enter each color value on a separate line and in sequence, to
determine the priority of each color.
To access a gift registry, recipients can click the link in the email they receive, or search by the
recipient’s name, email, or gift registry ID. In most stores, the footer of each page has a link to
the gift registry, although the location might vary by theme. In addition, the Widget tool can
be used to place Gift Registry Search anywhere in your store.
Registry visitors who want to make a purchase can add the item to their carts directly from the
gift registry. When the order is placed, the gift registry is updated to reflect the purchase.
Customers create their own registries. A customer creates a new gift registry from
their store account for an upcoming occasion, and completes the required fields in each
section of the gift registry. After adding items to the registry, it can be shared with friends
and family.
Invitations are sent. A link to the gift registry is included in each invitation.
If Gift Registry Search is available in the store, customers can search for specific gift
registries by name, email address, or gift registry ID.
Invitation recipients place orders. Those who receive an invitation can place an order
for any item directly from the gift registry.
As items are sold, Magento updates the gift registry item counts, and notifies the gift
registry owner.
Event Information The Event Information section includes the location and date of the
event. For a wedding, it might also include the number of guests each
person can bring.
Gift Registry Details The Gift Registry Details might include additional information that is
specific to the occasion.
Registrant Information The Registrant Information section includes the name and contact
information of each person who is to receive notification of the
registry. For a wedding registry, the Role field might be included to
associate the registrant as a friend of the bride or groom.
Shipping Address The Shipping Address section shows where gifts are to be sent, and
includes the information a carrier needs to deliver the package.
l Baby
l Birthday
l Wedding
When you create a new registry, it becomes an option in the list of gift registry types in the
customer’s account.
You can use one of the three prepared gift registries, or create your own custom registry. Each
gift registry type includes a number of attributes, which are the data entry fields that a
customer completes to create a gift registry. The attributes provide additional information
about the event, time and location, or any other information that is needed. Depending on the
input type, some attributes have multiple options. For example, the gift registry type
“Wedding,” has the attribute “Role,” with the options, “Bride,” “Groom,” and “Partner.” To learn
more about attributes and input types, see: Attributes.
The birthday, wedding, and baby registries are ready for customers to use from their accounts.
2. Make sure to complete the email template configuration, so they reflect your brand.
a. Enter a unique Code to identify the gift registry internally. The code must begin with a
lowercase letter. The rest of the code can be any combination of lowercase letters (a-z),
numbers (0-9), and underscore (_).
b. In the Label field, enter a name for the gift registry, as you want it to appear in the store.
This label will be an option in the list of gift registry types that are available to the
customer.
c. In the Sort Order field, enter a number to determine the order that this gift registry
appears when listed with other types.
General Information
4. Examine each section of the Gift Registry to determine the type of information you want to
include.
5. In the panel on the left, choose Attributes. Then, tap Add Attribute.
a. Assign a unique Code to identify the attribute internally. The code can be up to fifteen
characters in length, and must begin with a lowercase letter. The rest of the code can
include lowercase letters(a-z), numbers (0-9) and the underscore (_) character to separate
words.
b. Choose the Input Type to be used for data entry. You can use one of the custom or static
types.
Some input types have additional properties. For example, the Event Location has
additional properties to make the event searchable, and included in your store’s public list
of gift registries. If the input type has multiple options, tap Add New Option. Then complete
the following information for each option:
c. Set Attribute Group to the section in the gift registry where you want the attribute to
appear.
d. In the Label field, enter a name to identify the data entry field.in the registry.
e. If the customer is required to make a selection or enter a value in the field, set Is Required
to “Yes.”
f. In the Sort Order field, enter a number to determine the sequence in which this gift
registry appears when listed with other gift registries that might be available in the store.
7. To add another option, tap Add New Option. Each new option added appears in a new section at
the top. Then, repeat this process for the new attribute.
Field Descriptions
ATTRIBUTE DESCRIPTION
GENERAL INFORMATION
Code A unique name to identify the gift registry type internally. The first
character of the code must be a lowercase letter. The rest of the code
can be any combination of lowercase letters (a-z), numbers (0-9), and
the underscore character (_).
Label The name of the gift registry type that appears in the store.
Sort Order Determines the sequence in which this gift registry type appears
when listed with other types.
ATTRIBUTES
Input Type Determines the type of data and input control that is associated with
the attribute, according to type. Options:
Custom Types
Static Types
Event Location The location of the event that is related to the gift
registry.
Role The role that identifies who the gift is for. For
example, "Bride," "Groom," or "Partner."
Attribute Group Select the group where the attribute is listed in the gift registry.
Options:
Label The name that identifies the attribute in the customer's account
dashboard.
Is Required Indicates if the attributes is a required entry. The gift registry cannot
be saved until all required attributes are complete. Options: Yes / No.
Sort Order Determines the sequence in which attribute appears when listed with
other attributes.
l When a new gift registry is created, an email is sent to the owner with a link to registry that
can be shared.
l Optionally, the store can send notification to friends and family of the gift registry owner,
with a link to the gift registry.
l The owner is notified when items are purchased from the gift registry, but does not indicate
the purchaser.
Magento has predefined templates for each of these email messages that can be customized for
your brand.
Process Overview:
Step 1: Enable Gift Registries
Step 2: Configure Email Notifications
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
General Options
a. The Gift Registry is enabled by default. If necessary, set Enable Gift Registry to “Yes.”
b. In the Maximum Registrants field, enter the maximum number of people that can be
invited to participate in a gift registry event.
Owner Notification
a. Choose the Email Template that notifies gift registry owners when their registries are
created.
b. Choose the store contact that appears as the Email Sender of the message.
a. Choose the Email Template that notifies gift registry recipients when a registry is shared
with them.
b. Choose the store identify that appears as the Email Sender of the message.
c. In the Maximum Sent Emails Threshold field, enter the maximum number of emails that
can be sent at one time.
a. Choose the Email Template that notifies gift registry owners of changes to the registry.
b. Choose the store identify that appears as the Email Sender of the message.
5. When prompted, update the cache. After the cache is refreshed, Gift Registry appears in the
Stores menu under Other Settings, and becomes available in customer accounts.
c. Tap Continue.
b. Set Assign to Store Views to the store views where Gift Registry Search is to be available.
c. Set Sort Order to determine the order that the Gift Registry Search block appears if there
are other blocks assigned to the same location on the page.
Storefront Properties
5. In the Layout Updates section, tap Add Layout Update. To determine where the Gift Registry
Search appears in the store, do the following:
a. Set Display On to the pages in your store where you want Gift Registry Search block to
appear.
c. Set Container to the location on the page where you the Gift Registry Search block to be
placed.
Layout Update
6. In the panel on the left, choose Widget Options. To determine how visitors to your site can
search for gift registries, select as many of the following that apply:
l All Forms
Widget Options
8. When prompted to refresh the page cache, tap the link in the message at the top of the
workspace and follow the instructions.
Field Descriptions
FIELD DESCRIPTION
SETTINGS
Design Theme The theme that is used by the store where the Gift Registry Search is
to appear.
STOREFRONT PROPERTIES
Assign to Store Views Identifies the store views where the Gift Registry Search is to be
available.
Sort Order Indicates the order that Gift Registry Search block appears if there
are other blocks assigned to appear in the same location.
LAYOUT UPDATES
Display On Indicate the specific pages, or types of pages where Gift Registry
Search is to appear.
Container Indicates the page layout block where Gift Registry Search will be
placed. The options vary by template and theme.
WIDGET OPTIONS
Quick Search Form Types Determines the types of searches that can be performed with Gift
Registry Search. Options:
All Forms
Registrant Name Search
Registrant Email Search
Gift Registry ID Search
Customer Balance
Reward point balances can be managed by admin users per customer. If enabled in the storefront,
customers can also view the details of their points balance.
Redeeming Points
Points can be redeemed by admin users and (if enabled) customers during checkout. In the Payment
Method section, a Use my Reward Points checkbox appears above the enabled payment methods.
The available points and monetary exchange rate is included. If the available balance is greater than
the order grand total, no additional payment methods is required. The amount of reward points applied
to the order appears with the order totals, subtracted from the grand total, similar to a store credit or
gift cards. If reward points are used in conjunction with store credit or a gift card, the reward points are
deducted first, and the store credit or gift card is deducted if the order total is greater than the
redeemable amount of reward points.
Reward points are not recommended for use with COD purchases, because receipt of payment
cannot be confirmed until after the order is invoiced.
Reward Points
Process Overview:
Step 1: Configure the Reward Points
Step 2: Configure Points Earned for Customer Activities
Step 3: Complete the Email Notification Settings
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
b. To allow customers to earn their own reward points, set Enable Reward Points
Functionality on Storefront to “Yes.”
c. To allow customers to see a detailed history of their rewards, set Customers May See
Reward Point History to “Yes.”
4. In the Reward Points Balance Redemption Threshold field, enter the number of points that
must accrue before they can be redeemed. Leave blank for no minimum. Then, do the following:
a. Enter the maximum number of points a customer can accrue in the Cap Reward Points
Balance At field. Leave blank for no limit.
b. Enter the number of days before the reward points expire in the Reward Points Expire in
(days) field. Leave blank for no expiration.
Dynamic Calculates the number of days left whenever the reward point
balance increases. If the expiration limit in the configuration
changes, the expiration of all existing points update accordingly.
d. If you want to refund available reward points automatically, set Refund Reward Points
Automatically to “Yes.”
e. If you want to automatically deduct reward points from the amount of a refund, set
Deduct Reward Points from Refund Amount Automatically to “Yes.”
5. Set Landing Page to the content page that explains your reward points program. Make sure to
update the default Rewards Points page with your own information.
In this step, the number of reward points that can be earned for various customer activities is
specified. When customers complete an action that has points assigned, a message appears to
the customer that indicates how many points they have earned.
1. Expand the Actions for Acquiring Reward Points by Customer section. Then, do the
following:
a. To display a message in the shopping cart that includes the rewards points earned for the
purchase and the customer’s current reward point balance, set Purchase to “Yes.”
b. In the Registration field, enter the number of points earned for opening a customer
account.
c. In the Newsletter Signup field, enter the number of points earned by registered customers
who subscribe to a newsletter.
2. In the Converting Invitation to Customer field, enter the number of points earned by a
customer who sends an invitation, if the recipient then opens a customer account. Then, do the
following:
a. Enter a number in the Invitation to Customer Conversions Quantity Limit field to limit
the number of invitation conversions that can be used to earn points for the customer who
sends the invitation. Leave blank for no limit.
b. In the Invitation Conversion to Order Reward field, enter the number of points earned by
a customer who sends an invitation, and the recipient places an initial order.
3. In the Review Submission field, enter the number of points earned by a customer who
submits a review that is approved for publication. Then to limit the number of reviews that can
be used to earn points per customer, enter the number in the Rewarded Reviews Submission
Quantity Limit field. Leave blank for no limit.
a. Set Email Sender to the store contact that appears as the sender of balance updates and
expiration notifications.
c. Set Balance Update Email to the template used for the notification that is sent to
customers whenever their point balance is updated.
d. Set Reward Points Expiry Warning Email to the template used for the notification that is
sent to customers when the expiration limit for a batch of points is reached.
e. In the Expiry Warning Before (days) field, enter the number of days before points expire
that notification is sent.
When converting currency to points, the amount of points cannot be divided. Any currency
remainder is rounded down. For example, if $2.00 converts to 10 points, points will be earned
in groups of $2.00. Therefore, a $7.00 order would earn 30 points, and the remaining $1.00
would be rounded down. The monetary amount of the order is defined as the amount which the
merchant receives, or the grand total minus shipping, tax, discounts, store credit, and gift
cards. The points will be earned the moment when there are no non-invoiced items in the order
(all items are either paid or canceled). If an Admin user does not want to allow customers to
earn Reward Points for canceled orders, those points can be manually deducted from the
Manage Customers page.
a. Set Website to the sites where the reward exchange rate applies.
b. Set Customer Group to the groups where the reward exchange rate applies.
l Points to Currency
l Currency to Points
For either Direction setting, the amount is represented in the base currency of the website.
Points to Currency In the first Rate field, enter the number of points. In the second Rate
field, enter the monetary value of the points.
Currency to Points In the first Rate field, enter the monetary value. In the second Rate field,
enter the number of points that is represented by the monetary value.
When converting points to currency, the amount of points cannot be divided. For example, if
10 points converts to $2.00, points must be redeemed in groups of ten. Therefore, 25 points
would redeem for $4.00, with 5 points remaining in the customer’s balance.
Field Descriptions
FIELD DESCRIPTION
Website The website(s) where the reward rates apply.
Customer Group The customer group(s) to which the reward rates apply.
2. Scroll down and expand the Actions section. Then, enter the amount of points in the Add
Reward Points field.
When the price rule is activated, a message appears in the cart to let customers know how
many points they can earn by placing the order.
Event Components
Categories
Each event is associated with a category from your catalog.
Events
Event sales are based on a starting and ending date. You can use a countdown ticker to show
the time remaining.
Customer Groups
Category permissions are based primarily on customer groups.
Category Permissions
Category permissions gives you full control over the specific activities that can take place in a
given category.
Website Restrictions
Prevents public access to the site by redirecting to a landing page, login page, or registration
page.
Invitations
Email messages are sent with a link to create an account in the store. You can restrict the
ability to create an account to only those who receive an invitation.
Event Ticker
The ticker block displays a countdown ticker for open events, with the start and end date for
upcoming events. If an event has closed, the ticker shows the starting and ending dates.
Configuring Events
Before you can create an event, you must complete the basic configuration to enable events and
set up the event block in the sidebar.
Catalog Events
c. Enter the Number of Events to be Displayed in the Event Slider Sidebar Widget. By
default, this value is set to 5. If you want to display only one event in the slider at a time,
enter “1.”
d. Enter the number of Events to Scroll per Click in Event Slider Sidebar Widget. By
default, this value is set to 2. If you want the slider to display the next event in sequence
when clicked, enter “1.”
Restricting Access
Access to a private sale, event, or site can be limited to registered customers who log in, or
extended to non-registered customers who must register before gaining access.
Website Restrictions
To login form (302 Users are redirected to the login form before gaining access to the
Found) site.
To landing page Users are redirected to the specified landing page until they log in.
(302 Found)
Important! Be sure to include a link to the login page from the landing
page so customers can log in to access the site.
d. Choose the Landing Page that appears before customers log in to the private sale site.
e. To let search engine bots and spiders know that the landing page is correct, and that there
are no other pages on the site to index. set HTTP Response to “200 OK”
f. If you want the fields in the customer login and forgot password forms to be filled
automatically from previous entries, set Enable Autocomplete on login/forgot password
forms to “Yes”.
Sales Restrictions
By default, products that appear in upcoming or closed events are not available for general
sale, and the Add to Cart button does not appear on the product list or product page.
To restore the Add to Cart button for a closed event, the event must be deleted. However, if a
product is associated with another category that has no selling restrictions, the Add to Cart
button does appear on the product page. Similarly, the ticker block does not appear on the
product page if the product is associated with another category that has no selling restrictions.
Creating Events
Each event is associated with a category from your catalog, and only one event can be
associated with any given category at a time. To display a list of upcoming events in your
store, you must also set up a Catalog Events Carousel widget.
To create an event:
1. On the Admin sidebar, tap Marketing. Then under Private Sales, choose Events.
2. In the upper-right corner, tap Add Catalog Event. Then, do the following:
a. In the category tree, choose the category that you want to associate with the event.
Because each category can have only one event at a time, any categories that already have
an event are disabled .
Select Category
c. Use the calendar ( ) to choose the Start Date of the event. Then, use the Hour and
Minute sliders to set the time the event begins.
d. Use the calendar ( ) to choose the End Date of the event. Then, use the Hour and Minute
sliders to set the time the event ends.
e. To upload an Image for the event widget, tap Choose File. Then, select the image file from
your directory.
f. In the Sort Order field, enter a number to indicate the sequence in which this event
appears when listed with other events.
g. Select the checkbox of each page where you want to display the countdown ticker:
l Category Page
l Product Page
Field Descriptions
FIELD SCOPE DESCRIPTION
Category Global When creating a new event, this field links back to
the category tree. When editing an event, it links to
the category page related to the event.
Start Date Global The starting date and time of the event in
MMDDYYYY HH;MM format. Click the calendar
button to select the date.
End Date Global The ending date and time of the event in
MMDDYYYY HH;MM format. Click the calendar
button to select the date.
Image Store View Uploads an image that appears in the Catalog Events
Carousel widget.
Sort Order Global Determines the sequence in which this event appears
when listed with other events.
Display Countdown Ticker Global Displays the countdown ticker in the header of each
On page specified. Options include:
Category Page / Product Page
Status Global Indicates the status of the event based on the Start
Date and End Date range. Status is a read-only
value. Values include: Open / Closed / Upcoming
Updating Events
Events can be edited from either the Events page or from the category that is associated with
the event. When a category has an associated event, an Edit Event button appears in the
upper-right corner.
Edit Event
1. On the Admin sidebar, tap Marketing. Then under Private Sales, choose Events.
1. On the Admin sidebar, tap Products. Then under Inventory, choose Categories.
2. In the category tree on the left, select the category that is associated with the event. Then in
the upper-right corner, tap Edit Event.
is to appear, and control the width and number of events that appear at a time. The result you
get depends on your theme, where it’s positioned to appear on the page, and the options that
you choose.
1. Before you begin, follow the instructions to configure the Catalog Event widget is enabled for
the storefront.
Catalog Events
1. On the Admin sidebar, tap Content. Then under Elements, choose Widgets.
4. Tap Continue.
Widget Type
Widget Title Enter a descriptive title for your widget. This title is visible only
from the Admin.
Assign to Store Views Select the store views where the widget will be visible. You can
select a specific store view, or "All Store Views."
Sort Order (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.)
Storefront Properties
1. In the Layout Updates section, tap Add Layout Update. Then, do the following:
l Sidebar Additional
l Sidebar Main
The results vary according to theme and page layout. The “Catalog Events Carousel Default
Template.” must also be specified in the category configuration.
d. If you want the Events Carousel to appear in an additional location in the storefront, tap
Add Layout Update. Then, repeat these steps.
Layout Updates
For now, you can ignore the message to refresh the cache.
1. In the panel on the left, choose Widget Options. Then, do the following:
a. In the Frame Size field, enter the number of events that you want to list in the slider at
the same time. To view only one event at a time, enter “1.”
b. In the Scroll field, enter the number of event listings that you want to scroll per click. To
scroll to the next event, enter “1.”
2. For a custom width, enter the number of pixels in the Block Custom Width field. The custom
width for the example on this page is set to 250 pixels.
Widget Options
4. When prompted to refresh the cache, click the link in the message at the top of the workspace,
and follow the instructions.
Invitations
When invitations are enabled, customers can send and view invitations from the dashboard of
their customer accounts. The invitation email includes a link to your store’s Customer Login
page.
Invitation Workflow
Customer prepares invitations. From the account dashboard, the customer prepares
the list of recipients, and completes the invitation. A custom message can be included,
depending on the configuration.
Customer sends invitations. When ready, the customer taps the Send Invitations
button.
Customer monitors response. The customer monitors the status of each invitation
from the account dashboard, as having been Sent, Accepted, or Canceled.
Configuring Invitations
The invitation configuration enables invitations for the store, and determines how they are
sent.
To configure invitations:
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
General
b. To allow customers to manage invitations from the storefront, set Enable Invitations on
Storefront to “Yes.”
l Same as Inviter
l By Invitation Only
l Available to All
f. To limit the number of invitations that can be sent at one time, enter the number in the
Max Invitations Allowed to be Sent at One Time field.
a. Select the store identity to be used as the Customer Invitation Email Sender.
b. Select the Customer Invitation Email Template used for invitations sent.
604
Contents
In this section of the guide, you will learn how to Email
customize email and newsletter templates, as
well as PDF invoices and packing slips. You will Supported Email Clients
also learn how to personalize the content with Preparing Your Email Logo
variables and markup tags. Configuring Email Templates
Sales Email
Payment Failed Email
Admin Email
Customizing Email Templates
Header Template
Footer Template
Message Templates
Configuring Email Communications
Sales Documents
Configuring Sales Emails
PDF Logo Requirements
Adding Reference IDs to Header
Newsletters
Configuring Newsletters
Newsletter Templates
Sending Newsletters
Managing Subscribers
RSS Feeds
Using Variables
Adding Predefined Variables
Creating Custom Variables
Markup Tags
Variable Reference
605
CHAPTER 29:
Email
Email templates define the layout, content, and formatting of automated messages sent from
your store. They are called transactional emails1 because each one is associated with a specific
type of transaction, or event.
Magento includes a set of responsive email templates that are triggered by a variety of events
that take place during the operation of your store. Each template is optimized for any screen
size, and can be viewed from the desktop, as well as on tablets and mobile devices. You will
find a variety of prepared email templates related to customer activities, sales, product alerts,
admin actions, and system messages that you can customize to reflect your brand.
1An automated email message that is sent in response to a specific event or transaction.
Desktop Clients
OPERATING SYSTEM CLIENTS SUPPORTED
OS X 10.8 Apple Mail 6
Mobile Clients
OPERATING SYSTEM CLIENTS SUPPORTED
Android 4.2, “Jelly Bean” Native email app
IOS 8 iPhone 6
iPhone 6 Plus
IOS 6 iPhone 5
iPhone 4s
Web Clients
EMAIL APPLICATION BROWSERS SUPPORTED*
AOL Mail Chrome
Internet Explorer
Firefox
Gmail Chrome
Internet Explorer
Firefox
Outlook.com Chrome
Internet Explorer
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.
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.
Height: 48 px 144 px
Transactional Emails
Process Overview:
Step 1: Upload Your Logo
Step 2: Select the Header and Footer Templates
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.
If you have custom header and footer templates for your store, or for different stores, you can
specify which templates are used for each, according to the scope of the configuration.
1. Choose the Header Template to be used for all transactional email messages.
2. Choose the Footer Template to be used for all transactional email messages.
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
Make sure that you have updated each email template to reflect your brand. For a complete
list of templates, see: Email Template List.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
3. Expand the General Settings section. Then, set Asynchronous Sending to one of the
following:
General Settings
Order
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.
Order Comments
l Invoice
l Shipment
l Credit Memo
Make sure that you have updated each email template to reflect your brand. For a complete
list of templates, see: Email Template List.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
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.
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.
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.
Header Template
The email header template includes your logo that is linked to your store. In addition, you can
easily insert variables to add store contact information to the header.
Email Templates
Process Overview:
Step 1: Load the Template
Step 2: Customize and Preview the Template
Step 3: Update the Configuration
1. On the Admin sidebar, tap Marketing. Then under Communications, choose Email Templates.
a. Under Load default template, in the Template list under Magento_Email, choose
“Header.”
The HTML code and variables from the template appear in the form.
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.
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 markup tag for the variable is inserted in the code.
Insert Variable
Although the Store Contact variables are the ones most often included in the header, you
can enter the code for any system or custom variable directly into the template.
e. 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.
Your custom header now appears in the list of available Email templates.
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.
4. Choose the Header Template that is used as the default for email notifications.
Transactional Emails
Field Descriptions
FIELD DESCRIPTION
Template Lists the selection of available templates, and identifies the template
to be customized.
TEMPLATE INFORMATION
Insert Variable Inserts a Store Contact Information variable into the template at the
cursor location.
Template Subject The Template Subject appears in the Subject column, and can be
used to sort and filter the templates in the list.
Template Styles Any CSS style declarations that are needed to format the template
header can be entered in the Template Styles box.
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
1. On the Admin sidebar, tap Marketing. Then under Communications, choose Email Templates.
a. Under Load default template, in the Template list under Magento_Email, choose “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.
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 markup tag for the variable is inserted in the code.
Insert Variable
Although the Store Contact variables are the ones most often included in the footer, you can
enter the code for any system or custom variable directly into the template.
5. If you need to make any CSS declarations, enter the styles in the Template Styles box.
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.
4. Choose the Footer Template that is used as the default for email notifications.
Transactional Emails
Field Descriptions
FIELD DESCRIPTION
Template Lists the selection of available templates, and identifies the template
to be customized.
TEMPLATE INFORMATION
Insert Variable Inserts a Store Contact Information variable into the template at the
cursor location.
Template Subject The Template Subject appears in the Subject column, and can be
used to sort and filter the templates in the list.
Template Styles Any CSS style declarations that are needed to format the template
footer can be entered in the Template Styles box.
Message Templates
The process of customizing the body of each message is the same as the customizing the header
or footer. The only difference is that there is a different message template for each activity or
event that triggers a notification. You can use the templates as they are, or customize them to
match your voice and brand. In addition to the template text, there's a wide selection of
variables that can be incorporated into the template.
Process Overview:
Step 1: Load the Default Template
Step 2: Customize the Template
Step 4: Update the Configuration
Step 5: Preview and Save
1. On the Admin sidebar, tap Marketing. Then under Communications, choose Email Templates.
a. Under Load default template, in the Template list, choose the template that you want to
customize.
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.
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.
5. To insert a variable, position the cursor in the code where you want the variable to appear, and
tap Insert Variable. Then, choose the variable that you want to insert.
When a variable is selected, a markup tag for the variable is inserted in the code.
Insert Variable
In addition to the Store Contact variables, the list includes the Customer Account URL,
Customer Email, and Customer Name. However, you are not limited to the variables in this
list. You can enter the code for any system or custom variable directly into the template.
6. If you need to make any CSS declarations, enter the styles in the Template Styles box.
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.
3. Expand the section. Then, find the field for the email template that you customized, and
specify the new template as the default.
1. When you are ready to review your work, tap Preview Template. Then, make adjustments to the
template as needed.
Field Descriptions
FIELD DESCRIPTION
Template Lists the selection of available templates, and identifies the template
to be customized.
TEMPLATE INFORMATION
Insert Variable Inserts a variable into the template at the cursor location.
Template Subject The Template Subject appears in the Subject column, and can be
used to sort and filter the templates in the list.
Template Styles Any CSS style declarations that are needed to format the template
can be entered in the Template Styles box.
Email reminders can be triggered after a certain number of days have passed since a cart was
abandoned, or for any other condition you want to define, such as total cart value, quantity,
items in cart, and so on.
Email Reminders
Email reminders might promote a cart price rule with, or without, a coupon. A cart price rule that
defines an auto-generated coupon generates a random coupon code for each customer.
Rule Information
c. To choose the Cart Price Rule promotion that this reminder is to advertise, tap Select
Rule…. Then, select the rule.
d. If you want the rule to go into effect immediately, set Status to “Active.”
e. To set up a date range for the rule to be active, enter the From and To dates. You can also
choose the date from the Calendar ( ).
f. To send the reminder more than once, enter the number of days before the next email blast
in the Repeat Schedule field.
To repeat the reminder multiple times, separate the number of days with a comma. For
example, enter “7” to trigger the rule again in seven days; enter “7,14” to trigger the rule in
seven days, and again fourteen days later.
4. In the panel on the left, choose Conditions. At least one condition must be defined for the rule.
The process is similar to building a catalog price rule.
Conditions
a. Tap Add ( ) to display the list of options. Then, choose one of the following conditions:
l Wish List
l Shopping Cart
b. Complete the condition to describe the scenario that triggers the email reminder.
Completed Condition
6. In the Email Templates section, choose the email template to be used for each website and
store view in your store hierarchy.
If you don’t want to send the reminder email to customers of a store view, leave the value “Not
Selected.”
This value can be incorporated into email templates by using the promotion_name variable.
c. In the Titles and Descriptions Per Store View section, enter the Rule Title and Description
for the Default Store View. For multiple store views, enter the appropriate title and
description for each.
The description can be incorporated into email templates by using the promotion_description
variable.
Trigger Conditions
SOURCE TRIGGER
Wish List Number of days abandoned
Sharing
Number of items
Specific items
Field Descriptions
FIELD DESCRIPTION
RULE INFORMATION
Rule Name The name of the automated reminder rule identifies the rule internally.
Shopping Cart Price Rule The shopping cart rule that is associated with this email reminder.
Reminder emails can promote a shopping cart price rule with or
without coupon. If a shopping cart price rule includes an auto-
generated coupon, the reminder rule will generate a random, unique
coupon code for each customer.
Assigned to Website The websites to receive automated reminder emails based on this
rule.
Status Activates the rule. If status is inactive, then all other settings are
ignored, and the rule is not triggered.
Options: Active / Inactive
From Date The starting date for this automated reminder rule. If no date is
specified, the rule becomes active immediately.
To Date The ending date for this automated reminder rule. If no date is
specified, the rule becomes active indefinitely.
Email Templates Determines the email template to be used for each store view.
Rule Title for All Store Determines the title of the rule for each store view.
Views
Rule Description for All Determines the description of the rule for each store view.
Store Views
3. Expand the Automated Email Reminder Rules section. Then, do the following:
b. To set how often Magento checks for new customers who qualify automated email
reminders, set Frequency to one of the following:
l Minute Intervals
l Hourly
l Daily
c. Set the appropriate Interval, based on the Frequency setting. Then, set Start Time to the
hour, minute, and second the email is sent, based on a 24-hour clock.
d. To limit the number of emails that can be sent in a batch, enter the number in the
Maximum Emails per One Run field.
e. To avoid repeated attempts to send failed email, enter the maximum number of attempts
in the Email Send Failure Threshold field.
f. Set Reminder Email Sender to the store contact that appears as the sender of the
reminder email.
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.
Host localhost
Port (25) 25
c. Until the current security issue is resolved, we highly recommend that you set Set Return
Path to "No."
Specified Routes returned email to the email address specified in the Return
Path Email field.
4. In the panel on the left under Sales, choose Sales Emails. Then, do the following:
General Settings
l Import contacts
l Schedule campaigns
New Features
l New branding: In the Marketing Menu, “Marketing Automation” is now “Customer
Engagement.” In the Magento configuration, the “dotmailer” section under “General” is
now “Engagement Cloud.” The company dotmailer is now “dotdigital.”
l If enabled, displays the customer consent text in the customer's account dashboard as
general subscription text.
l The abandoned cart and automation process have a retry function if contacts are
pending.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
Create an Account
5. Wait a few moments while your account is created. Then when the “congratulations” message
appears, click Close ( ).
Engagement Cloud is now enabled, and your API Username and API Password appear in the
Settings section of the Magento configuration.
7. When prompted, click the Cache Management link in the message at the top of the page. Then,
refresh any invalid cache.
Account Credentials
1. In a new browser window, go to the dotdigital website. In the upper-right corner, click Login.
Then, do the following:
a. Enter your email address and password that you specified when you signed up for the
account.
b. Check your email for the authorization request message from dotdigital. Then, click the
activation link to get started. The activation link is valid for one hour.
If you can’t find the message, check your Junk Email folder.
2. During the welcome interview, you are asked to answer a few questions about your business.
Complete the interview, and navigate through the introduction. Then, tap Build your first
campaign. To continue, see: Create a Campaign.
At some point while working with your free trial, you’ll be asked to verify your account. When
prompted, click the free trial message above the header, and follow the instructions. Until then, the
status of your account will be “unverified.”
Account Details
Use the Account option on the Settings menu to update your information and settings, and
view your account dashboard.
Account
c. To add a Billing contact, tap New billing contact. Then, enter the email address of the
billing contact, and tap Save.
Field Descriptions
FIELD DESCRIPTION
COMPANY DETAILS
Purchase order number The purchase order assigned by your company for making payments
for your Engagement Cloud account.
BILLING ADDRESS
BILLING CONTACTS
New billing contact Allows you to enter the email address of an additional billing contact.
Account Access
Use the Access option on the Settings menu to add users, and set permissions. Initially, the
person who sets up the account is assigned as the “account holder” with responsibility to
manage the account.
In addition to general account access, the account holder and any other user with appropriate
permissions can set up access for API and transactional email users.
Access
b. Under Permission, mark the checkbox of each activity or type of information that the user
has permission to access.
Add a User
4. An invitation to join the account is sent to the email address of the new user. To activate the
account, the new user must click the activation link, and provide their contact and login
information.
When the account is verified, the new user is added to the Access list, and is logged in to the
account. A chat session opens to help the new user set goals and learn their way around.
1. Find the user in the Access list. Then in the Edit column, click Edit ( ).
2. On the Manage Users page, update the User Details and Permission settings as needed.
Manage Users
1. Tap the Settings icon at the bottom of the sidebar. Then on the menu, choose Account.
When ownership is transferred, you lose access to key administration areas of the account. The
only way to reverse the change is for the new account owner to transfer the account back to
you.
1. Find the user in the Access list, and mark the checkbox in the first column.
Account Permissions
PERMISION DESCRIPTION
All permissions Has unrestricted access to the Engagement Cloud account.
Can create contacts Can add individual users and upload multiple users to the account.
Can manage account Can edit account settings and see invoices.
Can send without approval Can send without approval. (Requires Sender permission.)
Template Administrator Can manage the template library. (Requires Edit campaigns
permission.)
API Users
The API allows developers to establish integration with other systems, and automate tasks. The
Engagement Cloud API version 2.0 web service supports both REST and SOAP.
As a best practice, it is recommended that you create one API user per supported system. For
example, having only one API user for your Magento integration makes it easier to isolate and
diagnose problems, and change privileges.
Only the account owner or another user with the “Can manage account” permission can create
API users. To learn more, see Getting started with the API.
API Users
a. Accept the randomly-generated Email address. Each API user must have a unique email
address.
Because this field appears in the list after the randomly-generated email address, it should
make the user easy to identify.
c. Click the password field, and enter the password for the user. Then, enter the password
again to confirm.
Manage Users
The new API user is added to the Access list.
Transactional email messages are in a legally distinct category, and must not contain any
content that is related to marketing or sales.
To send transactional email through the API you can use either the REST operation Send
transactional email or the SOAP method SendTransactionalEmail. Transactional email is sent
by SMTP, and requires a dedicated user email address. To learn more, see Transactional email -
an overview.
a. Accept the randomly-generated Email address. Each transactional email user is assigned
a unique email address.
Because this field appears in the list after the randomly-generated email address, it should
make the user easy to identify.
Create a Campaign
Engagement Cloud includes a large selection of professionally-designed email and newsletter
templates for a variety of promotions and events. You can use any of the prepared templates, or
design your own.
As you become familiar with Engagement Cloud, take advantage of the wealth of information
that is available to you at all times. Help resources include online chat, suggested articles that
relate to your current activity, training videos, and the Developer hub.
Help Resources
In the following example, you will rework a prepared template for the Magento Luma demo
store, and become familiar with different types of content building blocks and editing
techniques.
2. On the Free Templates tab of the Choose a Template page. Scroll down to find the template
you want to use. Then, do the following:
a. Hover over the thumbnail image, to show the Select and Preview buttons. Then, do the
following:
b. When prompted, enter the Campaign name, and accept the default Campaign location.
Then, tap Continue.
c. For an overview of the process, click setting up your campaign in the message at the top
of the page.
d. Under Campaign Details, complete the fields for the header information of the campaign
email. To learn more, see the field descriptions.
e. Scroll down to see a Preview of the message. Then, tap Save & continue.
Preview
Before you get started, it’s important to know that you can save your work at any time. If you
log out and continue your work later, you can find the most recently saved version of your
campaign in the menu under Campaigns > My Campaigns. To continue editing, find your
campaign in the list, and click its name.
The content editor uses building blocks to represent each type of content that can be added to
the template. The Build tab of the sidebar on the left displays the selection of building blocks
that you can drag and drop into position. For this example, we will replace the sample content
in the template with content of our own.
The following instructions walk you through each section of the template, and introduce
editing and formatting tools, and techniques.
The space above the header can be used to enter a brief message. You can either click the text
box, and enter the text that you want to appear above the header, or delete the placeholder
text.
Preheader Text
a. On the Build tab, scroll down and expand the Images section.
b. To upload your logo, click Manage. Then, click here to upload the image.
Image manager is similar to Media Storage, and is used to organize images that are
available in your Engagement Cloud account.
It is recommended to limit the combined size of all images in a campaign to less than 100kb.
Image Manager
d. To organize your images, click New folder in the upper-left corner. Then, enter a name for
the untitled folder. The new folder is nested below the original parent folder.
You can create as many folders as you need, and organize them any way you want. Over
time you will upload many images to your account, and it’s important to organize them in
a way that makes them easy to find.
e. In the sidebar, click the parent folder that contains the logo that you uploaded. Then,
drag the image to the new folder. Then, click Close ( ) in the upper-right corner to
return to the content editor.
New Folder
The logo that you uploaded appears in the sidebar, where it can be dragged into position.
f. Drag your logo to the header to replace the placeholder image in the template.
The next section of the template represents your store’s menu. However, it’s actually a building
block with a multi-column layout, similar to a table. The text in each cell can be edited and
formatted separately. The Columns building block iin the sidebar can be used in many ways to
control the text layout.
a. Click the menu area to see the multi-column layout. The Columns building block is
located in the sidebar under Layout.
b. Click each cell, and enter the menu options for your store. Then, use the toolbar to change
the font, size, and style of the text, as needed.
Add Links
To link each menu option in the template to your store, do the following:
a. Open your store in another window, and click the first menu option. Then, copy the full
URL.
b. In the template, select the text for the first menu option. Then in the toolbar, click the
Hyperlink ( ) tool.
c. In the Link (URL) field, paste the link that you copied from your store.
d. Enter the Link title. Then, enter the Link name for tracking.
Add a Link
a. In the sidebar, choose the Styles tab. Notice that Background layers is set to “Element
table).” In the underlying HTML of the template, the menu background is actually part of
a table.
b. In the template, hover over the menu background to highlight the entire row.
c. In the sidebar under the color picker, enter the hexadecimal code for the background color
of your store’s menu. In the Magento Luma store, the background color of the menu is
#f0f0f0.
d. Tap Save colour to save the color in the My colors section of the sidebar.
Background Color
a. On the Build tab of the sidebar, under Images, click Add Image ( + ).
b. Choose the banner image that you want to upload. After a moment, the image appears in
the sidebar.
c. From the sidebar, drag the new banner to replace the placeholder image.
Banner
Engagement Cloud gives you the ability to dynamically incorporate data from your store into a
template. However, for this simple example, product data is added as static images with links
to your store. Although this template includes two rows of products, only one row is included
to reduce the number of images. The “Shop Now” blocks was also removed from the template,
because it didn’t introduce any new editing techniques.
The price can be updated as any other text field. To change the currency, simply type a
dollar sign, or any other currency symbol that you need.
c. To update the product buttons, click the button to display its settings in the sidebar.
d. Paste the Button URL for the corresponding product detail page. Then, update the color
and format of the button as needed.
Button Settings
Delete Blocks
To simplify this example, only one product block is needed from the template. You can delete
the other two blocks that feature products from the catalog.
a. Find the block with the “Shop Women” and “Shop Men” tiles.
b. Hover over the outer container. Then in the upper-right corner, click Delete ( ).
Delete Block
c. Delete the second product block, so only the one that you updated remains.
a. Scroll down to the “Sharing” block with the social media placeholders.
b. In the building blocks sidebar under Tools, drag the Social links building block into
position below the “Sharing” block with the placeholders.
c. Click the empty building block to open the Social links settings.
d. Mark the checkbox of each social link that you want to include in the template.
e. For each social link, paste the URL of your company profile page.
Social Links
g. To adjust the format and spacing of the buttons, click anywhere in the social links
building block. You can experiment with these settings to adjust the size and format of
the buttons. To make your buttons look like the template, do the following:
j. To delete the placeholder social media links, click Close ( ) in the upper-right corner.
The information at the bottom of the template is important, and in many countries is required
by law. You must provide a mechanism for recipients to unsubscribe, and clearly identify the
sender of the email.
a. Do not change the Unsubscribe and Forward this email links, because they contain code
that manages each operation. However, you can format the text any way you like.
b. Click the Footer info text block, and enter your company information, including your
registration number, if applicable, so recipients know who has sent the email.
Footer Info
c. Click the Company registered address text block, and complete the information. In this
example, we added a link to the Contact Us page on our site.
Test Send
2. Select the type of output you want to send from the following:
l HTML only
3. To send the test to the address that is associated with your account, tap Select Test Address.
b. Enter the Email address, First name and Last name of the recipient.
c. Tap Create.
5. When you are ready to send the test campaign, tap Test Send. If prompted, tap Save and send.
The Summary Report validates the campaign, lists any errors that are found, and suggests
areas for improvement. In addition to the Summary Report, the Reports menu has a selection
of Marketing Automation reports.
My Campaigns
2. In the record for your test campaign, click Summary ( ) to view the summary report.
Look for the red text in the report. They are tips and recommendations for things you can do to
improve your campaign.
In this step, we’ll add a personal note with a link, and then do another test run.
1. On the Build tab of the sidebar under Building blocks, drag a Text block to the top of the
template.
a. Enter the word “Hi” to begin the greeting, followed by a blank space.
Data Fields
Personalized Greeting
Desktop Preview
2. In the upper-right corner of the preview window, click Phone ( ), and choose Portrait.to see
how the message looks on a mobile device.
Phone Preview
Congratulations!
Field Descriptions
FIELD DESCRIPTION
CAMPAIGN DETAILS
Subject line The subject line is what the recipient sees in their Inbox summary.
Options:
Friendly from name Replaces the full email address in the Inbox. To include a custom
data field, use the field picker to the right of the field. Option:
Campaign Tags Tags are used to filter campaigns for reports. To add another tag,
press the Tab key.
The contact list in the main menu at the top of the page includes customer, guest and
subscription data that is automatically imported from your store.
My Contacts
2. To view the import report, click the Notifications bell ( ) in the upper-right corner.
Address Books
Notifications
The Contacts import report includes a summary of all subscribers as well as duplicates,
failures, soft and hard bounces, invalid email addresses, and those who have unsubscribed, or
have been blocked, globally suppressed, or otherwise blacklisted. You can use this report to help
keep your data clean.
Import Report
6. In the main menu, return to Contacts > My Contacts. This time, click the Magento_
Customers address book.
7. To see all the things you can do with your customer data, click More actions.
Using what we’ve covered so far, you should be able to create a newsletter campaign and send
it to your list of subscribers.
To schedule a campaign:
1. On the main menu under Campaigns, choose My Campaigns.
2. Find your test campaign in the list, and in the last column, click Send ( ). Then, do the
following:
a. Under Step 1, mark the checkbox of each address book that contains contacts to be
targeted by the campaign.
b. Under Step 2, choose the Scheduled option. Then, click the Calendar ( ) to choose the
Date and enter Time that the campaign will be sent.
c. Under Step 3, select “Yes” if you want to automatically resend the campaign to anyone
who hasn’t opened it after a specific number of days. you can also change the subject line
of the message. By default, campaigns are not sent a second time.
Remail Options
4. Take one last look at the report before you send the campaign. Then, scroll down to the bottom
and tap Send campaign immediately. When prompted to confirm, tap Send.
6. On the menu, choose Dashboard to see your progress. You have completed the first four tasks,
and a notification is waiting for you in the upper-right corner.
Automate a Campaign
Engagement Cloud includes three prepared automation templates, plus a blank template that
you can use to create custom programs. When setting up an automated campaign, you can use
existing campaigns, or create placeholders for new ones. This example uses a prepared template
to create a simple Welcome campaign with a follow-up message that is sent a week later.
Choose a Template
1. On the Engagement Cloud main menu, choose Automation. Then above the list of campaigns,
tap New program.
My Programs
2. In the Get started section of templates, hover over the Welcome program template, and tap
Select. Then, do the following:
3. When prompted, enter the Program name. For now, you can accept the Programs folder
location. Then, tap Continue.
Program Name
The Edit program workspace includes a flowchart of the program logic. Each box in the
diagram is a node. The panel on the left has a selection of nodes that can be added to the
program. You can create sophisticated automated processes using these simple building blocks.
Welcome Program
1. In the flowchart Start node. click the “Create a start condition” text box.
The panel on the left provides an overview of the process, and walks you through each step.
Start
b. For this example, accept the default scheduling. Then, tap Apply.
Enrollment Scheduling
The options describe the event that triggers the rule. For this program, the welcome email
campaign will be triggered whenever a new account is created.
a. Under “Select start rule type,” accept Trigger from contact date field. Tap Select date field.
Then, choose Contact date as the field that triggers the rule.
b. Accept “0” for the number of days to wait after the contact date, for the rule to go into
effect. Then, select the date field that contains the value that triggers the rule.
4. Under 3. Enrolment limits, tap Set enrolment limits. Then, do the following:
a. For this program, accept the default option to re-enrol contacts every day they meet the
start criteria. Then, tap Apply.
This option ensures that every person who signs up for a new account will be included in
the next scheduled mailing.
Enrolment Limits
Automated programs send triggered campaigns. You can either choose an existing campaign
that is set up to be triggered by a rule, or create a placeholder for a new campaign.
1. In the flowchart, click the Campaign node. Then, tap Create campaign.
Send Campaign
a. Enter the Campaign name, and accept the default Campaigns location.
b. Tap Create.
Create Campaign
2. Tap Apply.
Delay
2. Enter the Campaign name, and accept the Campaigns folder as the default Campaigns
location.
Follow-up Campaign
2. For this example, you can accept the default name of the end point.
3. Tap Apply.
End Node
If you added placeholders for new campaigns, you still need to complete the definition of each
campaign. However, if you used existing campaigns, your Welcome program is good to go!
My Campaigns
Exclusion Rules
An exclusion rule can be created to exclude abandoned cart and review emails from being sent
under certain conditions. A rule describes the conditions that must be met to trigger the action.
For example, a rule might exclude all abandoned carts with a subtotal that is equal to, or less
than ten.
Exclusion Rules
Rule Information
c. Leave Status set to “Inactive” for now. You can later change it to “Active.”
3. Before you define the condition, think about what you want the rule to accomplish. Then,
describe the condition in terms of attribute values and actions. A rule can be set to meet any or
all of the stated condition, and a single rule can have multiple conditions.
On the Conditions tab, set Conditions Combination Match to one of the following:
l ANY
l ALL
d. For multiple conditions, tap Add New Condition. Then, repeat these steps.
l Invoices
l Packing Slips
l Credit Memos
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.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
3. Expand the Invoice and Packing Slip Design section. Then, do the following:
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.
4. Enter your address as you want it to appear on invoices and packing slips.
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:
2. Mark the Delete Image checkbox for the image you want to replace.
Image Formats
FORMAT REQUIREMENTS
HTML
Resolution 72 or 96 DPI
PDF Print-outs
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
Invoice
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
General
{{/if}}
Address Templates
3. Expand the Address Templates section. The section includes a separate set of formatting
instructions for each of the following:
l Text
l HTML
l PDF
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 Marketplace.
Configuring Newsletters
The first step in creating newsletters is to configure the newsletter settings for your site. You
can require customers to click a confirmation link that is sent by email to confirm the
subscription. This double opt-in1, method requires customers to confirm twice that they want
to receive your newsletter, and reduces the possibility that it might be considered to be spam.
Subscription Options
1The process for subscribing email recipients by requiring them to take a secondary step to confirm that they want
to receive emails.
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.”
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
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:
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.
Template Information
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: Using the Editor.
Do not remove the unsubscribe link at the bottom of the template content. In some
jurisdictions, the link is required by law.
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.
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.
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.
2. To preview the HTML version of the template, tap Preview Template. The preview opens in a
new browser tab.
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.”
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.
a. Enter a brief description of the newsletter for the Subject line of the email header.
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.
Queue Information
6. If applicable, enter a note in the Message box above the instructions to unsubscribe. Do not
remove the instructions, which are required by law in many jurisdictions.
Newsletter Queue
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.
Unsubscribe
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.
l CSV
l XML
3. Tap Export. Then, look for the prompt at the bottom of the screen, and save the file.
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 software that is required to read an RSS feed is called a feed reader1, and allows people to
subscribe to headlines, blogs, podcasts, and much more. Google Reader is one of the many feed
readers that are available online for free.
RSS Feeds
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.
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
Catalog
7. Expand the Order section. Then, set Customer Order Status Notification to “Enable.”
Coupons / Discounts Publishes notification of any special coupons or discounts that are
available in the store.
Top Level Category Publishes notification of any change to the top-level category
structure of your catalog, which is reflected in the main menu.
Customer Order Status Gives customers the ability to track their order status by RSS feed.
When enabled, an RSS feed link appears on the order.
l Predefined Variables
l Custom Variables
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.
Custom Variables
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.
Markup Tags
A markup tag is a directive that contains snippet of code with a relative reference to an object in
your store, such as a variable, URL, image, or block. Markup tags can be used anywhere the
editor is available and incorporated into the HTML of content pages, blocks, email templates,
newsletters, and so on.
Markup tags are enclosed in double, curly braces, and can either be generated by the Widget
tool, or typed directly into HTML content. For example, rather than hard-coding the full path
to a page, you can use a markup tag to represent the store URL. The markup tags featured in
the following examples include:
Inserting many directives, especially widgets like the Recently Viewed / Compared Products type,
can produce a negative effect on the first page load when the page is not cached. For this reason,
we advise that you use them with caution. In most cases, it should not create an issue. But this is
something that you should discuss with your development team.
Custom Variable
The Variable markup tag can be used to insert a custom variable into an email templates,
blocks, newsletters, and content pages,
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'}}
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.
{{block class="Magento\Contact\Block\ContactForm"
name="contactForm" template="Magento_Contact::form.phtml"}}
The code in the next example can be added to a page or block to display the a list of products
in a specific category, by category ID.
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.
{{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.
Process Overview:
Step 1: Identify the Destination URL
Step 2: Add the Markup to the URL
Step 3: Complete the Anchor Tag
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.
http://mystore.com/apparel/shoes/womens
http://mystore.com/apparel/shoes/womens.html
http://mystore.com/apparel/shoes/womens/nine-west-pump
http://mystore.com/apparel/shoes/womens/nine-west-pump.html
http://mystore.com/about-us
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 url Places a forward slash at the end, so additional references can be
appended as a path.
In the following examples, the URL Key is enclosed in single quotes, and the entire markup tag
is enclosed in double curly braces. When used with an anchor tag, the markup tag is placed
inside the double quotes of the anchor. To avoid confusion, you can alternate using single-and
double quotes for each nested set of quotes.
1. If you are starting with a full URL, delete the “http address” part of the URL, up through and
including the “dot.com forward slash.” In its place, type the Store URL markup tag, up
through the opening single quote.
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='
{{store url='apparel/shoes/womens'}}
2. To complete the markup tag, type the closing double quotes and double braces.
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.
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.
As with all markup tags, the directive is enclosed in double curly braces. The format of a
dynamic media URL looks like this:
{{media url="path/to/image.jpg"}}
Dynamic URL directives are processed from saved HTML content when the page is rendered on
the storefront. Each time the page is rendered, the content is scanned for {{media
url="..."}}, and replaces the directive with the corresponding media URL.
Inserting many directives, especially widgets like the Recently Viewed / Compared Products type,
can produce a negative effect on the first page load when the page is not cached. For this reason,
we advise that you use them with caution. In most cases, it should not create an issue. But this is
something that you should discuss with your development team.
By default, images inserted into the catalog from the WYSIWYG editor 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.
WYSIWYG Options
4. Set Use Static URLs for Media Content in WYSIWYG to one of the following:
Yes Uses static URLs for media content that is inserted with the WYSIWYG editor.
Static URLs are absolute, and break if the base URL of the store changes.
No (Default) Uses dynamic URLs for media content that is inserted with the
WYSIWYG editor, based on the {{media url="..."}} directive. Dynamic URLs
are relative, and do not break if the base URL of the store changes.
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.
l Marketplace Extensions
Connect to Facebook
Magento Commerce has removed the "Magento Social" Facebook integration, and no longer
supports the extension.
Magento Social is an integration that establishes a connection between your store and your
Facebook account, and creates a shopping page with products from your catalog. When
shoppers click a product on your Facebook page, they are redirected to the corresponding
product page in your Magento store. All transactions take place from your Magento store.
736
Contents
In this section of the guide, we'll take a look at the Catalog Navigation
search capabilities of your store, what you can
learn from customer search terms, and how to Top Navigation
make your products easy to find. Finally, you’ll Breadcrumb Trail
learn best practices and techniques that you can Product Listings
use to bring more traffic to your store. Pagination Controls
Layered Navigation
Catalog Search
Quick Search
Advanced Search
Search Results
Weighted Search
Configuring Catalog Search
MySQL
Elasticsearch
Using a Flat Catalog
Meta Data
Canonical Meta Tag
Catalog URLs
SEO URL Rewrites
Configuring URL Rewrites
Automatic Product Redirects
Creating URL Rewrites
Search Terms
Popular Search Terms
Adding Search Terms
Search Terms Report
Using a Sitemap
Google Tools
Google Analytics
Google Tag Manager
Google Adwords
737
CHAPTER 37:
Catalog Navigation
The term navigation1 refers to the methods shoppers use to move from page to page
throughout your store. The main menu, or top navigation of your store is actually a list of
category links, and provides easy access to the products in your catalog. You will also find
categories in the breadcrumb trail that runs across the top of most pages, and in the layered
navigation that appears on the left side of some two- or three-column pages. To learn more
about category display options, see: Display Settings.
For a product to be visible in your store, it must be assigned to at least one category. Each
category can have a dedicated landing page with an image, static block, a description, and a
list of products in the category. You can also create special designs for category pages that are
active only for a specific period of time such as for a holiday or promotion.
Catalog Navigation
1The primary group of web page links that a customer uses to navigate around the website; the navigation links to
the most important categories or pages on an online store.
Top Navigation
The main menu of your store is like a directory to the different departments in your store. Each
option represents a different category of products. The position and presentation of the top
navigation might vary by theme, but the way it works is essentially the same.
Top Navigation
The category structure of your catalog can influence how well your site is indexed by search
engines. The more deeply nested a category, the less likely it is to be thoroughly indexed. As a
general rule, anywhere between one and three visible levels is considered to be the most
effective. The root category counts as the first level, although it doesn't appear in the menu.
The maximum number of levels that are available in the top navigation is determined by the
configuration. In addition, there might be a limit to the number of menu levels that are
supported by your store theme. For example, the sample Luma theme supports up to five
levels, including the root.
Level 2 On a desktop display, the top navigation is the main menu that
appears across the top of the page. On a mobile device, the main
menu typically appears as a fly-out menu of options. The second-
level options in the Luma store are “What's New,” “Women,” “Men,”
“Gear,” “Training,” and “Sale.”
Level 3 The third-level appears below each main menu option. For example,
under “Women,” the third-level options are “Tops” and “Bottoms.”
Level 4 The fourth-level options are subcategories that fly out from a third-
level option. For example, under “Tops,” the fourth level menu options
are “Jackets,” “Hoodies & Sweatshirts,” “Tees,” and “Bras & Tanks.”
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.
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
2. In the panel on the left under General, choose Web. Then, do the following:
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.
2. Scroll down and in the panel on the left, tap Catalog. Then choose Catalog.
Storefront
l Grid Only
l List Only
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.
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.
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.”
Page Controls
CONTROL DESCRIPTION
View As Displays the products in either a grid or list format.
Show Per Page Determines how many products appear per page.
Pagination Controls
The Pagination settings appear at the top and bottom of the list, and control the format of the
pagination links for product listings. You can set the number of links that appear in the
control, and configure the Next and Previous links. For the pagination links to appear, there
must be more products in the list than are allowed per page in the product list configuration.
Pagination Controls
Pagination Controls
View As
Displays the list in either a Grid or List format.
Sort By
Changes the sort order of the list. The “Used for Sorting in Product
Listing” storefront property determines which product attributes can
be used to sort the list.
Pagination Links
Navigation links to other pages.
2. Find the store view that you want to configure. Then in the Action column, click Edit.
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.
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.
Filterable Attributes
Layered navigation allows customers to search and browse products using facets 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).”
The following instructions show how to set up basic layered navigation with filterable
attributes. For advanced layered navigation with price steps, see: Price Navigation.
Process Overview:
Step 1: Set Up the Attribute Properties
Step 2: Make the Category an Anchor
Step 3: Test the Results
1. On the Admin sidebar, tap Stores. Then under Attributes, choose Product.
2. Find an attribute in the list using the filtered search or browsing. Select the filter to open in
edit mode.
a. In the panel on the left, choose Storefront Properties. Then, set Use In Layered
Navigation to one of the following:
Filterable (with Layered navigation includes only those filters for which matching
results) products can be found. Any attribute value that already applies to
all products shown in the list should still appear as an available
filter. Attribute values with a count of zero (0) product matches are
omitted from the list of available filters.
The filtered list of products includes only those that match the
filter. The products list is updated only if the selected filter(s)
change what is currently shown.
Filterable (no Layered navigation includes filters for all available attribute values
results) 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. Price layered filtering is not supported by
this option, and does not affect Price filters.
Storefront Properties
3. Repeat these steps for each attribute that you want to include in layered navigation.
The Position field will be grayed out by default. You must save the attribute before you can modify
this setting.
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.
4. Tap Save .
To test the setting, visit 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.
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 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.
a. By default, Display Product Count is set to “Yes.” The change the setting, first clear the
Use system value checkbox.
Layered Navigation
Leave Price Navigation Steps Calculation set to the default, “Automatic (Equalize Price
Ranges.)” This setting uses the standard algorithm for price navigation.
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.
Method 3: Manual
To change the value of any of the following fields, first clear the Use system value checkbox.
Manual
2. In the panel on the left, expand the Catalog section. Then choose Catalog.
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.
l Quick Search
l Advanced Search
l Search Results
l Flat Catalog
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
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.
2. In the Advanced Search form, full or partial values in as many fields as necessary.
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.
Search Results
The Search Results list includes all products that match the search criteria entered in the Quick
Search box or the Advanced Search form. Every product list in the catalog has essentially the
same controls. The only difference is that one is the result of a search query, and the other is
the result of navigation.
The results can be formatted as either a grid or list, and sorted by a selection of attributes.
Pagination controls appear if there are more products than fit on the page, and are used to
move from one page to the next. The number of records per page is determined by the Catalog
Frontend configuration. To learn more, see Product Listings.
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
3. In the panel on the left, choose Storefront Properties. Then, do the following:
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.
MySQL
MySQL is the default search engine used by Magento Commerce.
Elasticsearch
Elasticsearch is a powerful and highly scalable distributed search engine that is used by many
industry leaders with high-volume sites.
Maximum Query Length Store View The maximum number of characters allowed in a
catalog search.
The value set for this option must be compatible with
the corresponding range set in your selected search
engine configurations. For example, if you set this
value to 300 in Magento, update the value in your
search engine.
Number of top search Store View The number of popular search terms and results to
results to cache cache for faster responses. Entering a value of 0
caches all search terms and results when entered a
second time. Default value: 100
Autocomplete Limit Store View The maximum number of search results to display for
search autocomplete. Restricting this amount
increases performance of searches and reduces the
displayed list size. Default value: 8
Search Suggestions Count Store View The maximum number of search suggestions offered.
Default value: 2
Show Results Count for Store View Determines if the number of search results is shown
Each Suggestion for each suggestion. Depending on theme, the number
usually appears in brackets after the suggestion.
Options: Yes / No
Search Recommendations Store View Specifies the number of search terms offered as
Count recommendations. By default, no more than five are
shown.
Show Results Count for Store View When set to "Yes," the number of products found for
Each Recommendation the proposed search recommendation is shown in the
brackets. Options: Yes / No
MySQL
MySQL is the default search engine. By adjusting the Catalog Search configuration, you can
control the behavior of the search operations and determine the size of valid query text and the
display of search recommendations. By default, MySQL always has the EAV Indexer enabled.
This feature improves indexation speed and restricts the indexer from use by 3rd party
extensions.
MySQL Configuration
4. By default, the Search Engine is set to “MySQL.” If switching to MySQL, select that option.
This affects the available fields.
5. To limit the length and word count of search query text, set the Minimal Query Lengthand
Maximum Query Length.
Important: The value set for this minimum and maximum range must be compatible with the
corresponding range set in your MySQL search engine configurations. For example, if you set these
values to 2 and 300 in Magento, update the values in your search engine.
6. To limit the amount of popular search results to cache for faster responses, set an amount for
Number of top search results to cache.
The default is 100. Entering a value of 0 caches all search terms and results when entered a
second time.
7. To limit the maximum number of search results to display for search autocomplete, set an
amount for Autocomplete Limit. Restricting this amount increases performance of searches
and reduces the displayed list size. The default amount is 8.
a. In the Search Suggestion Count field, enter the number of suggestions to offer for each
search term that returns no results. The default is 2.
b. To display the number of search results for each suggested term, set Show Results Count
for Each Suggestion to “Yes.”
a. In the Search Recommendations Count field, enter the number of recommendations that
you want to offer. The default is 5.
a. To display the number of results for each recommendation, set Show Results Count for
Each Recommendation to “ Yes.”
Elasticsearch
Elasticsearch is a powerful and highly scalable distributed search engine that is used by such
high-volume sites as eBay, Wikipedia, and GitHub. The implementation of Elasticsearch
includes both search suggestions and recommendations. For installation instructions, see Set
up Elasticsearch service in the developer documentation.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
4. For the Search Engine field, clear the Use system value checkbox and choose the version that
is installed on your server.
Elasticsearch (Deprecated) Elasticsearch 2.0+ has reached end of life, and is now
deprecated. To learn more, see Elastic Product End of Life Dates.
Elasticsearch 5.0+ (Default) Elasticsearch 5.0+ is scheduled for end of life. To learn more,
see Elastic Product End of Life Dates.
Elasticsearch 6.0+ (Recommended) For the best performance, we recommend that you use
the latest version of Elasticsearch 6.0+.
To learn more about using Elasticsearch versions 2.x and 5.x, see Change the Elasticsearch Client.
Elasticsearch Settings
5. For Enable EAV Indexer, set if you want to enable or disable the Product EAV indexer. This
feature improves indexation speed and restricts the indexer from use by 3rd party extensions.
This option only displays for Elasticsearch or Elasticsearch 5.0+ Search Engines.
6. To limit the length and word count of search query text, set the Minimal Query Lengthand
Maximum Query Length.
Important: The value set for this minimum and maximum range must be compatible with the
corresponding range set in your Elasticsearch search engine configurations. For example, if you set
these values to 2 and 300 in Magento, update the values in your search engine.
7. To limit the amount of popular search results to cache for faster responses, set an amount for
Number of top search results to cache.
The default is 100. Entering a value of 0 caches all search terms and results when entered a
second time.
8. To limit the maximum number of search results to display for search autocomplete, set an
amount for Autocomplete Limit. Restricting this amount increases performance of searches
and reduces the displayed list size. The default amount is 8.
3. In the Elasticsearch Index Prefix field, enter a prefix.to identify the Elasticsearch index. For
example: Magento2.
4. Set Enable Elasticsearch HTTP Auth to “Yes” to use HTTP authentication to prompt for a
username and password to access Elasticsearch Server.
5. In the Elasticsearch Server Timeout field, enter the number of seconds before the system times
out. The default is: 15.
a. In the Search Suggestions Count field, enter the number of search suggestions to offer.
b. To show the number of results found for each suggestion, set Show Results for Each
Suggestion to “Yes.”
b. To show the number of results found for each recommendation, set Show Results Count
for Each Recommendation to “Yes.”
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.”
By default, Popular Search Terms is enabled as a search engine optimization tool, but has no
direct connection to the catalog search process. Because the Search Terms page is indexed by
search engines, any terms on the page can help improve your search engine ranking and the
visibility of your store. The URL of the Popular Search Terms page is:
mystore.com/search/term/popular/
4. Clear the Use system value checkbox. Then, set Popular Search Terms as needed.
You can further configure the caching of popular searches and additional options for your configured
search engine MySQL or Elasticsearch.
Search Terms
1. On the Admin sidebar, tap Marketing. Then under SEO & Search, choose 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.”
1. In the Search Terms grid, click the row of any record to open the search term in edit mode.
Search Synonyms
One way to improve the effectiveness of catalog search is to include different terms that people
may use to describe the same item. You don’t want to lose a sale just because someone is
looking for a “sofa,” while your product is listed as a “couch.” Or perhaps they spelled it wrong,
or just differently. Is it a sweatshirt, or a sweat shirt? Maybe it’s a fleece or a hoodie. You can
capture a broad range of search terms by entering all the possible words a customer might use
to find your products.
Search Results
The Search Synonyms grid appears. If this is the first time you have used search synonyms, the
grid will be empty.
b. Enter each synonym in the group, separated by comma. Choose words that people might
use as search criteria. For example:
c. To merge these synonyms into a group with others that have the same scope, mark the
Merge existing synonyms checkbox.
Commerce Resources
See the latest Magento eBooks to gain access to expert
insight and online business resources to help develop
and improve your store.
Meta Data
Learn more about adding and enhancing keyword-rich
meta data for your site and store.
Using a Sitemap
A site map improves the way your store is indexed by
search engines, and is specifically designed to find
pages that might be overlooked by web crawlers. A site
map can be configured to index all pages and images.
URL Rewrites
The URL Rewrite tool lets you change any URL that is
associated with a product, category, or CMS page.
Meta Data
Your store is loaded with places where you can enter keyword-rich meta data to improve the
way search engines index your site. While setting up your store, you might enter preliminary
meta data, with the intention of finishing it later. Over time, you can fine-tune the meta data
to target the buying patterns and preferences of your customers.
Meta Title
The meta title appears in the title bar and tab of your
browser, and search results listings. The meta title
should be unique to the page, and less than seventy
characters in length.
Meta Keywords
Although some search engines ignore meta keywords,
others continue to use them. The current best practice is
to incorporate high-value keywords in the meta title and
meta description.
Meta Description
Meta descriptions provide a brief overview of the page for
search results listings. Ideally, a meta description should
be between 150-160 characters in length, although the
field will accept up to 255 characters.
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.
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
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
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 domain-
name/product-url-key. However, the product can also be accessed using its full URL, which
includes the category. For example, if the product URL key is driven-backpack, and is
assigned to the Gear > Bags category, the product can be accessed using either URL.
You can avoid being penalized by search engines by omitting the category from the URL, or by
using the canonical meta tag to direct search engines to index either by product or category. As
a best practice, it is recommended that you enable canonical meta tags for both categories and
products.
To change any field values, you must first clear the Use system value checkbox after each field.
4. If want search engines to index only category pages using the full category path, do the
following:
5. If you want search engines to index product pages only using the domain-name/product-url-
key format, do the following:
When enabled, Magento creates a file called sitemap.xml that is saved to your installation in
the location that you specify. The configuration gives you the ability to set the frequency of the
updates, and the priority for each type of content. Your site map should be updated as
frequently as the content on your site changes, which might be daily, weekly, or monthly.
While your site is in development, you might include instructions in the robots.txt file for
webcrawlers to avoid indexing the site. Then before the launch, you can change the instructions
to allow the site to be indexed.
For technical information, see: Add sitemap and robots.txt in the developer documentation.
Process Overview:
Step 1: Configure the Site Map
Step 2: Generate the Site Map
Step 3: Configure and Enable robots.txt (Optional)
Step 4: Submit Your Site Map to Search Engines
Step 5: Restore the Previous Robot Instructions (Optional)
Complete the XML Sitemap configuration to determine what is included, and how frequently
the site map is updated.
1. On the Admin menu, choose Marketing. Then under SEO & Search, choose Site Map.
Site Map
b. Enter the Path to determine where the site map file is to reside on the server. Make sure
that the path is writeable.
/ Places the site map file at the base path, or root of your Magento
installation.
It might take a few minutes for the site map to appear in the grid.
1. In the Site Map grid, right-click the URL in the Link for Google column.
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
Column Descriptions
COLUMN DESCRIPTION
ID The sequential record number of the current site map.
Path The location where the site map resides on the server. For example:
Link for Google The URL of the site map that is to be submitted to Google and other
search engines.
Last Generated Indicates the date and time the site map was last generated.
Store View The store view where the site map applies.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
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
Products Options
6. Click to expand the CMS Pages Options section. Then, complete the Frequency and Priority
settings as needed.
Generation Settings
a. Set Start Time to the hour, minute and second that you want the sitemap to be updated.
l Daily
l Weekly
l Monthly
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.
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.
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.”
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.
User-agent:*
Disallow:
User-agent:*
Disallow: /
Default Instructions
Disallow: /lib/
Disallow: /*.php$
Disallow: /pkginfo/
Disallow: /report/
Disallow: /var/
Disallow: /catalog/
Disallow: /customer/
Disallow: /sendfriend/
Disallow: /review/
Disallow: /*SID=
To configure robots.txt:
1. On the Admin sidebar, tap Content. Then under Design, choose Configuration.
2. Find the Global configuration in the first row of the grid, and click Edit.
3. Scroll down and expand the Search Engine Robots section. Then, do the following:
INDEX, FOLLOW Instructs web crawlers to index the site and to check back
later for changes.
NOINDEX, FOLLOW Instructs web crawlers to avoid indexing the site, but to
check back later or changes.
INDEX, NOFOLLOW Instructs web crawlers to index the site once, but to not
check back later for changes.
NOINDEX, NOFOLLOW Instructs web crawlers to avoid indexing the site, and to not
check back later for changes.
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.
The terms rewrite and redirect are often used interchangeably, but refer to slightly different
processes. A URL rewrite changes the way a URL appears in the browser. A URL redirect, on
the other hand, updates the URL that is stored on the server. A URL redirect can be either
temporary or permanent. Your store uses URL rewrites and redirects to make it easy for you to
change the URL key of a product, category, or page and preserve existing links.
By default, automatic URL redirects are enabled for your store. The "Create Permanent Redirect
for old URL" checkbox is marked under the URL key field of each product.
http://www.yourdomain.com/magento/index.php/storeview/url-identifier
http://www.yourdomain.com/magento/storeview/url-identifier
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
4. Set Create Permanent Redirect for URLs if URL Key Changed to “Yes.”
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 the Search Engine Optimization section. Then in the URL Key field, do the
following:
a. Make sure that the Create Permanent Redirect for old URL checkbox is selected. If not,
follow the instructions to enable automatic redirects.
b. Update the URL Key as needed, using all lowercase characters and hyphens instead of
spaces.
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.
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 the Search Engine Optimization section. Then in the URL Key field, do the
following:
a. Make sure that the Create Permanent Redirect for old URL checkbox is selected. If not,
follow the instructions to enable automatic redirects.
b. Update the URL Key as needed, using all lowercase characters and hyphens instead of
spaces.
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.
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
http://www.example.com/ergonomic-keyboard.html
http://www.example.com/all-on-sale.html
http://www.example.com/save-now/spring-sale
URL Rewrites
Product Rewrites
Before you begin, make sure that you understand exactly what the redirect is to accomplish.
Think in terms of "target" and "original request," or "redirect to" and "redirect from." Although
people might still navigate to the former page from search engines or outdated links, the
redirect causes your store to switch to the new target.
If automatic redirects are enabled for your store, there is no need to create a rewrite when a
product URL Key is changed.
Process Overview:
Step 1. Plan the Rewrite
Step 2: Create the Rewrite
Step 3. Test the Result
1. To avoid mistakes, write down the "redirect to" path and "redirect from" path. The path
includes the URL Key and suffix, if applicable.
If you're not sure, open each product page in your store, and copy the path from the address
bar of your browser. When creating a product redirect, you can either include or exclude the
category path. For this example, we create a product redirect without a category path.
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.
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.
6. In the grid, find the product that is the target—or destination—of the redirect. Then, click the
row.
7. Below the category tree, tap Skip Category Selection. For this example, the redirect does not
include a category.
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.
l Temporary (302)
l Permanent (301)
URL Rewrite Information
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.
The new product rewrite now appears at the top of the URL Rewrites grid.
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.
The new target product appears instead of the original product request.
Field Descriptions
FIELD DESCRIPTION
Create URL Rewrite Indicates the type of rewrite. The type cannot be changed after the
rewrite is created. Options:
Custom
For category
For product
For CMS page
Target Path The internal path that is used by the system to point to the destination
of the redirect. The target path is grayed out and cannot be edited.
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.
Category Rewrites
If a category is removed from your catalog, you can use a category rewrite to redirect links to
the URL of another category in your store. Think in terms of "target" and "original request," or
"redirect to" and "redirect from." Although people might still navigate to the former page from
search engines or outdated links, the redirect causes your store to switch to the new target.
If automatic redirects are enabled for your store, there is no need to create a rewrite when a
category URL Key is changed.
Process Overview:
Step 1: Plan the Rewrite
Step 2: Create the Rewrite
Step 3: Test the Result
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
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.
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.
Category Tree
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.
l Temporary (302)
l Permanent (301)
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.
The new category rewrite appears at the top of the URL Rewrites grid.
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 DESCRIPTION
Create URL Rewrite Indicates the type of rewrite. The type cannot be changed after the
rewrite is created. Options:
Custom
For category
For product
For CMS page
Target Path The internal path that is used by the system to point to the destination
of the redirect. The target path is grayed out and cannot be edited.
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.
Process Overview:
Step 1: Plan the Rewrite
Step 2: Create the Rewrite
Step 3: Test the Result
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.
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.
3. When you return to the URL Rewrites page, tap Add URL Rewrite.
5. Find your new target page in the grid, and open in edit mode.
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.
l Temporary (302)
l Permanent (301)
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.
The new rewrite appears in the grid at the top of the list.
Saved URL Rewrite
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 DESCRIPTION
Create URL Rewrite Indicates the type of rewrite. The type cannot be changed after the
rewrite is created. Options:
Custom
For category
For product
For CMS page
Target Path The internal path that is used by the system to point to the
destination. The target path is grayed out and cannot be edited.
No No redirect is specified.
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.
Process Overview:
Step 1: Plan the Rewrite
Step 2: Create the Rewrite
Step 3: Test the Result
1. To avoid mistakes, write down the URL of the "redirect to" page, and the URL key of the
"redirect from" page.
If you're not sure, open each page, and copy the URL from the address bar of your browser.
Custom Path
Redirect to: http://www.different-website.com/page.html
category.html
category/subcategory.html
product.html
category/product.html
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.
3. When you return to the URL Rewrites page, tap Add URL Rewrite.
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.
l Temporary (302)
l Permanent (301)
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.
The new rewrite appears in the grid at the top of the list.
Saved URL Rewrite
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.
Field Descriptions
FIELD DESCRIPTION
Create URL Rewrite Indicates the type of rewrite. The type cannot be changed after the
rewrite is created. Options:
Custom
For category
For product
For CMS page
Request Path The path to the product, category, or CMS page that is to be
redirected. Depending on your configuration, the Request Path might
include the .html or .htm suffix.
The Request Path must be unique, and cannot be in use by another
redirect. If you receive an error that the Request Path already exists,
delete the existing redirect, and try again.
Target Path The path or URL that is the destination of the redirect.
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.
l Google Analytics
l Google AdWords
2. At the bottom of the left sidebar, choose Admin. Then, navigate to the account that you want
to edit, if applicable.
3. In the Account column, click Account Settings. Then, adjust the following settings to support
GDPR requirements:
l Benchmarking
l Technical support
l Account specialists
1. Scroll down the page to Data Processing Amendment. Then, tap View Adjustment.
2. Tap Review Amendment to read tead the Google Ads Data Processing Terms. Then, tap
Accept..
a. Enter the information for the first contact. Then, mark the checkbox of each
applicable role.
Primary Contact (Notification Email Address) The contact to whom notices are
sent.
Anonymize IP Addresses
1. To anonymize the IP addresses used by Google Universal Analytics, add the following
snippent to the analytics.js library on your web server:
analytics.js
If you use the legacy ga.js library, add the following snippet:
ga.js
2. To anonymize the IP addresses used by Google Tag Manager, set the anonymize_ip
parameter to true in the gtag.js library on your web server,
gtag.js
Force SSL
To force all Google data to be transmitted over a secure socket layer (SSL), add the following
snippet to the analytics.js library on your web server.
analytics.js
l Does not use other Google services in conjunction with Google Analytics cookies.
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.
If your business operates in areas that are governed by the General Data Protection Regulation,
see: Google Settings for GDPR .
Google Analytics
Process Overview:
Step 1: Sign Up for Google Universal Analytics
Step 2: Complete the Magento Configuration
Visit the Google website, and sign up for a Google Universal Analytics account. See Google's
Set up Site Search and the Google Analytics Guide for the basics you need to get started.
1. Return to your store, and log in to the Admin. On the Admin sidebar, tap Stores. Then under
Settings, choose Configuration.
c. If you want to conduct A/B testing and other performance tests on your content, set
Content Experiments to “Yes.”
Google Content Experiments has been deprecated, and will eventually be replaced by Google
Optimize.
2. Follow the instructions to enable Google Analytics with Content Experiments in the Magento
configuration.
You can create up to ten variations of each entity that you want to test. For products, use Save
& Duplicate to save time.
You must have the appropriate permissions to the Google account to create an experiment.
1. Open another browser tab, and log into your Google Analytics account. If necessary, navigate
to the Account and Property.
2. In the sidebar on the left, choose Admin. Then, do one of the following:
In the header of the View column, click the down arrow, and choose the view that is to
provide the data for the experiment.
1. In the header of the View column, tap Create View. Then, do the following:
l Website
l Mobile app
2. When complete, tap Create View. Then, click the back arrow to return to the previous
page.
3. In the panel on the left under Reports, choose Behavior > Experiments.
b. Specify the Original Page URL and the URLs of each page variation that you want to test.
c. Complete the other options. If you need help see: .Configure & Modify Experiments.
5. When the experiment is set up, tap Manually Insert the Code. Then, copy the code snippet.
1. Return to the Admin of your Magento installation. Then, open the original version of the
product, category, or page in edit mode.
2. Expand the View Optimization section for the product, category, or page. Then, paste the code
snippet that you copied from Google Analytics into the Experiment Code text box.
3. If ready to begin, tap Start Experiment. Otherwise, tap Save for Later.
Google Tag Manager directly transfers data and events to Google Analytics, Enhanced
Ecommerce and other third-party analytics solutions, to produce a clear picture of how well
your site, products, and promotions are performing.
You should have a Google Analytics and Tag Manager account to continue this process. The
following instructions walk you through the process of configuring your Google accounts,
configuring your Magento store, and creating a tag.
If your business operates in areas that are governed by the General Data Protection Regulation,
see: Google Settings for GDPR .
Process Overview:
Step 1: Configure Your Google Analytics Account
Step 2: Configure Your Google Tag Manager Account
Step 3: Configure Your Store
See Google's Set up Site Search for the basics you need to get started. Also see the Google
guides for Google Analytics and Google Tag Manager.
b. Under Advertising Features, set Enable Demographics and Interest Reports to “On”.
5. Reload the page to verify that all the settings remain “On”.
If not all settings are “On,” repeat the previous steps, save, and reload the page. Repeat this
process until all settings are set to “On”.
The following instructions show how to configure a new container with the basic settings. A
sample Composer configuration (.json) file is used to simplify the process, importing to
generate a tag in a new container. For this example, we recommend that you create a new
container, rather than modify an existing container.
For additional information, see Google's Container export and import. These instructions walk-
through importing a sample JSON to a new container.
1. Right-click this link: GMT_M2_Config_json.txt. Choose Save link as to download the sample
text file. Then, do the following:
The zipped file will be uploaded directly to Google Tag Manager, and does not need to be
copied to your server.
4. Under Choose workspace, tap New. Enter a title and description, then tap Save.
l The Merge option should be selected is you are using an existing container.
b. Choose Google Analytics. Then, update the placeholder (UA-xxxxxx-x) with your own GA
ID.
8. Follow Google’s instructions to add tags, triggers, and variables to the new container.
If you have settings in another container that you want to use, they can be moved to the new
container.
9. Tap Confirm when complete. Follow Google’s instructions to publish the new container.
2. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
d. If you are also using Google Analytics to content experiments, set Enable Content
Experiments to “Yes.”
6. Test your Google Tag Manager settings to verify that everything works correctly.
Field Descriptions
FIELD SCOPE DESCRIPTION
Enable Store View Determines if Google Analytics Enhanced
Ecommerce can be used to analyze activity in your
store.
Options include: Yes / No
Account type Store View Determines the Google tracking code that is used to
monitor store activity and traffic. Options include:
Google Analytics
Google Tag Manager
Enable Content Store View Activates Google Content Experiments, which can be
Experiments used to test up to ten different versions of the same
page. Options: Yes / No
List property for the Store View Identifies the Tag Manager property associated with
catalog page the catalog page. Default value: Catalog Page
List property for the cross- Store View Identifies the Tag Manager property associated with
sell block the cross-sell block. Default value:Cross-sell
List property for the up-sell Store View Identifies the Tag Manager property associated with
block the up-sell block. Default value: Up-sell
List property for the related Store View Identifies the Tag Manager property associated with
products block the related products block. Default value: Related
Products
List property for the search Store View Identifies the Tag Manager property associated with
results page the search results page. Default value: Search
Results
“Internal Promotions” for Store View Identifies the Tag Manager property associated with
promotions field “Label” the labels for internal promotions. Default value: Label
Process Overview:
Step 1: Create a Tag
Step 2: Create a Rule
Step 3: Preview and Publish
1. Log in to your Google Tag Manager account. Then, click the link for the container that you
created for your store.
3. You will need the following information from your AdWords account:
l Conversion ID
l Conversion Label
4. From the Google Tag Manager dashboard, tap Google AdWords. Then, do the following:
a. Tap the title placeholder, and enter a name for the new tag.
Choose Product
c. Under Choose a Tag Type, select AdWords Conversion Tracking. Then, tap Continue.
5. Enter the Conversion ID and Conversion Label from your AdWords account. Then, tap
Continue.
Configure Tag
Variable: url
Value: checkout/success.*
3. Mark the green checkbox, and tap Save. The trigger that you set up appears as a blue button in
the Fire On section.
Enhanced Ecommerce
Enhanced Ecommerce is a plugin for Google Universal Analytics that gives you insight into the
shopping and purchasing behavior of your customers. You can use Enhanced Ecommerce to
produce reports about key customer activities, such as when customers add items the cart,
begin the checkout process, or complete a purchase. You can also identify and analyze patterns
of shoppers who abandon their carts without making a purchase.
The following instructions show how to configure Google Tag Manager with Universal Analytics
to produce Enhanced Ecommerce data and reports.
1. Sign up for a Google Tag Manager account, and complete the Magento configuration.
2. Create a new property for Enhanced Ecommerce analytics with the following settings:
Status ON
Related Products ON
1. Sign in to your Google Tag Manager account, and create the following triggers:
2. Create the following Universal Analytics tags with the same basic configuration.
Category Ecommerce
Trigger AddToCart
Category Ecommerce
Trigger CheckoutOption
Trigger gtm.dom
Category Ecommerce
Trigger ProductClick
Category Ecommerce
Trigger PromotionClick
Category Ecommerce
Trigger RemoveFromCart
4. When complete, tap Preview and verify that the tags work correctly.
Troubleshooting Tools
Both Google Tag Manager and Universal Analytics have debug modes with a variety of tools
that you can use to troubleshoot your integration.
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.
a. On the Tools tab of your AdWords dashboard, choose Conversions. Then, tap
Conversion.
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.
e. Tap Conversion windows, and complete the settings to determine how long the conversions
are to be tracked, the reporting category, and attribution model.
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.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
3. In the panel on the left, under Sales, choose Google API. Then, expand the Google
AdWords section and do the following:
a. If necessary, clear the Use Website checkbox for each setting to be changed.
Google AdWords
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.
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.
<!-- Google Code for Back to School Sale Conversion Page -->
<script type="text/javascript">
/* <![CDATA[ */
var google_conversion_id = 999999999;
/* ]]> */
</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>
Dynamic Determines that a conversion has occurred based on the dynamic Order
Amount value.
For a Constant conversion value type, enter a specific Value for the Order Amount to qualify as
a conversion.
848
CHAPTER 44: Google Shopping ads Channel
Simplify your Google promotions and ad campaign management by integrating your Magento
catalog with Google through Magento's Google Shopping ads. This extension syncs your
Magento product catalog and other information with your Google Merchant Center (GMC) and
Ads accounts to promote and sell products. When you have integrated your Magento catalog,
you can manage your GMC catalog and publish Google Smart Shopping ads campaigns directly
from Magento.
This guide provides insights to Google accounts, onboarding, managing your catalog, and
developing campaigns. See the following sections to install, onboard, and start selling with
Google.
Have questions? Check out the Google Shopping ads Channel FAQ and best practices topics
to better understand Google and Magento integrations. You can also perform a search for Google
Shopping ads in the Magento Help Center for additional troubleshooting topics.
Managing Ad Campaigns
Magento supports only Google Smart Shopping
campaigns, allowing you to create and manage
campaigns directly through the Admin.
To simplify creating and managing products and campaigns with Google, you just need to
understand the following concepts and complete a few onboarding steps. This section helps you
get started quickly.
Have questions? Check out the Google Shopping ads Channel FAQ and best practices topics
to better understand Google and Magento integrations. You can also perform a search for Google
Shopping ads in the Magento Help Center for additional troubleshooting topics.
l Onboard in a single process to import and map product data with Google attributes to best
match product searches and advertisements to conditions, age groups, product types, and
more
Google Shopping ads Channel leverages your Magento product catalog, syncing product data
and configured attributes directly with Google. We take the guesswork out of mapping to
Google attributes, allowing you to select from existing attributes, using Google attributes, or
adding new Magento attributes for various categories including product type, condition, age
group, gender, and more.
Syncing at regular intervals each day, Magento checks for any issues with your account and
products, listing disapprovals and reasons through the dashboard. Click, review, and update
required product data changes to kick off Google reviews for new approvals. As you make
changes to product data, quantities, and prices, we sync those updates to Google on save.
Updates should display on Google within an hour of saving in Magento.
By default, your GMC account can support 150,000 total line items in your product feed and
countries. For example, if you sell and promote a product across three countries, the total
number counts against your total. If you exceed this quota, you will receive an account error of
too many products. Magento cannot extend or affect this quota. To increase your limit, contact
Google with this form.
You only need to access GMC for advanced configurations including shipping and taxes.
Manage all products, settings, and reports through the Magento Admin.
l Claim and Verify: Google must verify and claim your storefront URL to associate it to your
GMC account. Verifying adds markers to your site for Google to locate and confirm that you
are the authorized owner of both your website and your Merchant Center account. Claiming
reserves the URL you verified for use with your Merchant Center account. URL status
includes "Claimed and Verified" and "Unclaimed".
l Approval and Disapproval: Google marks products as approved if they pass all product and
policy requirements. Products have the Pending Approval status until reviewed.
Disapproved products have an issue that must be resolved and submitted for another
review. Approved products can be searched and displayed through Google.
l Attributes: Google uses attributes as a form of mapping imported Magento product data.
Magento attributes can be mapped to these Google attributes to ensure Google properly uses
your product data. For details on attributes, see Google's Product data specification. If you
select to create a new attribute during the onboarding process, it is named Google Merchant
Center Category.
Google Ads
Google Ads provides an online advertising program to sell your products through Google. The
account and tools support multiple types of ads to target networks, keywords, and search
results with the best matching products. Magento Google Shopping ads Channel supports only
a Smart Shopping Ads campaigns, integrating your GMC products with advanced Google
systems to create and test different product asset and information combinations as relevant ads
across Google networks. The system tracks performance of ads based on responses and click-
throughs, regulating your advertisements per an allocated daily budget.
Simplify your ad campaign management, increase your sales, and expand your reach with
Smart Shopping campaigns. Smart Shopping campaigns combine elements of your existing
product feed and assets with Google’s machine learning to show a variety of ads across
different ad networks. Networks include the Google Search Network, the Google Display
Network, YouTube, and Gmail. Smart Shopping campaigns feature both Product Shopping ads
and display ads (including Remarketing Ads and Similar Audiences).
Smart Shopping campaigns are easy to use. Simply link to a GMC account, set a budget,
confirm the country of sale, and select products. Google systems use your approved products
and test different combinations of product image and text, then show the most relevant ads
across Google networks. To help you get the best value from each ad, Google automates ad
creation, ad placement, and bidding to maximize sales at your given budget.
l Aligned to your marketing objective by focusing on increasing sales for your budget.
l Improve cost efficiency by fully automating bidding so you can focus more time on strategic
tasks.
l Cross-channel optimization that ensure your budget is spent optimally across the Google
Search Network, Display networks, and YouTube
Magento supports creation and management of Smart Shopping campaigns. Easily create and
manage your Smart Shopping campaigns directly through the Magento Admin:
l Advertise across the globe by selecting countries from the list. Google displays ads for those
locations, displaying translated product data if those locales are configured and translated
in your catalog.
l Set a daily budget to define an average amount for advertising spending per campaign
l Select all products or a filtered group to display in ads. As products sync and approve with
GMC, they also display as part of the campaign if they match the parameters.
l Create, pause, and end campaigns without scheduling. Manually create, pause, and end
campaigns as needed.
You only need to access Google Ads to configure your payment method. Access and review all
ads, settings, and reports through the Magento Admin.
l Shopping Ads: An ad displaying your rich merchant data including product name, image,
link, description, price, and more.
l Campaign: Method of managing and customizing ads. Magento supports Smart Shopping
campaigns.
l Timezone: Setting for your Ads account that determines the timezone for Google reporting.
l Currency: Setting for your Ads account that determines the currency used to set budgets for
your ads and shows in reporting.
l Budgets: Your ad campaigns have a daily budget that sets the average maximum amount
you want spend for displaying and promoting the Smart Ads per day. Google has intelligent
tracking and algorithms to evaluate the popularity of your products, ad displays and click-
throughs, and much more. If an ad is popular with significant click-throughs, Google may
promote the ad more, possible spending more of your budget. The amounts balance, never
exceeding your average, and rolling over amounts not spent from one day to the next.
l Status: The status indicates if your campaign is running ads, is available, or ended. Google
supports a number of ad status options. Magento supports a specific set: Active (ads able to
run), Paused, Ended (no longer running).
l Launch Date: The date the campaign was submitted and started in Magento. When ended,
the date clears.
Onboarding Process
We provide an onboarding process, walking you through the steps to create and configure
accounts much like a wizard. Each screen will prompt you for specific information with helpful
tips. For complete details, see the Onboarding Google Shopping ads. After you complete
onboarding, continue managing your account and products during the approval process. The
Google Shopping ads dashboard and details pages keep you informed with options to review
and resolve issues as notified by Google.
The integration supports all Magento product types excluding gift cards, grouped products,
and simple products with required options. Google also recommends not selling products
requiring customization or personalization.
Have questions? Check out the Google Shopping ads Channel FAQ and best practices topics
to better understand Google and Magento integrations. You can also perform a search for Google
Shopping ads in the Magento Help Center for additional troubleshooting topics.
If you have additional steps to complete, banners display with information and next steps. See
each section to review and manage your GMC account, product updates, and campaign status.
If you do not have custom Magento attributes, you may add Magento attributes and values or
select the best matching Google attributes. Any Google values selected and configured do not
save back into your Magento catalog.
GOOGLE MAGENTO
ATTRIBUTE ATTRIBUTE DESCRIPTION
Title Product Name The name of your product.
(default)
Google Product Custom attribute Google supports a product category for each product.
Category Categorizing your product helps ensure that your ad
is shown with the right search results. If you do not
use category attributes in Magento, select the best
matching Google category.
GTIN Custom attribute This is the Global Trade Item Number typically
Global Trade assigned by manufacturers to a product. Depending
Item Number on your product, you may receive a different type of
GTIN including UPC, EAN, JAN, ISBN, or ITF-14. To
find your GTIN, see Google's Find a GTIN. For this
option, select the type of GTIN or none if you do not
have an assigned value. If you do not have a GTIN,
you may have an MPN.
GOOGLE MAGENTO
ATTRIBUTE ATTRIBUTE DESCRIPTION
Brand Custom attribute The specific brand of your products. If you sell
products manufactured by other companies, you
may have assigned the brand for categories, searches,
and layered navigation.
Identifier exists Custom attribute Attribute(s) that identify any new products without
a gtin and brand or mpn and brand. For details, see
Google's identifier_exists: Definition.
Adult only Custom attribute Attribute(s) indicating the product is or is not adult-
GOOGLE MAGENTO
ATTRIBUTE ATTRIBUTE DESCRIPTION
APPAREL AND ACCESSORIES ATTRIBUTES
ADULT-ONLY CONTENT ATTRIBUTES
Sales Price Final Price The final price calculated in the Magento catalog
including discounts. Due to complex nature of
Magento pricing, we use this price to map to Google
Sales Price. This value is automatically supplied
from Magento to Google.
l All attributes map and set the data Google saves into its catalog and displays in ads.
l Google allows you to sync and sell up to 150,000 total line items in your product feed and
countries. For example, if you sell and promote a product across three countries, the total
number counts against your total. If you attempt to sell more than 150,000 unique
products, Google will disable and reduce the number of active products available. To
increase your limit, contact Google with this form.
l While products are waiting to be approved, they have a Pending Approval status.
l The initial push of data to Google completes in waves, mapping and collecting for review.
The process of validation and approval takes much more time. The complete process of
product data and review can take up to 10 days to complete for larger product catalogs.
l After products are received and approved in your Google product catalog, any updates in
mapped attributes, quantity, price, and availability (in-stock/out-of-stock)are received and
posted within an hour. Every save of product data in the Magento Admin is collected and
synced to Google using a cron job (added as part of the extension).
l If you save price changes to products, or remove products, Magento immediately sends
those updates to Google. You should see the updated prices and removals within an hour
after saving changes. This is separate from product approval status checks with Google.
For details, see Google's About ads approval process and Promotion approval process.
l For product data requirements, see Google's Product data specification and our best
practices.
l For more information on disapprovals, see Google's About item and account disapprovals
for product data violations and About item disapprovals for policy violations.
l To review and resolve disapprovals, see Managing Google Products and Managing Google
Accounts.
Have questions? Check out the Google Shopping ads Channel FAQ and best practices topics
to better understand Google and Magento integrations. You can also perform a search for Google
Shopping ads in the Magento Help Center for additional troubleshooting topics.
l Turn off pop-up blockers in your web browser. Some browsers may include pop-up blockers
by default (like Chrome). You cannot complete onboarding with pop-up blockers enabled.
Login screens open to Google using pop-up windows.
l Always check back on your Account and Product Errors to resolve issues. Magento performs
some validation immediately, listing products that are missing information required by
Google before review. Google performs revolving checks on your product updates to complete
reviews for corrected and added products.
l After onboarding completes, we check for product approval and account status with Google
every 30 minutes for the first 10 days of your integration. Google may require up to 72 hours
to review all products submitted in your onboarding process. After the first 72 hours,
Magento checks product and account status once every hour.
l For complex shipping and tax settings, you have an option to configure these settings in
Google after account creation. Select that option and access your GMC account later to
update. You must complete these Google configurations for products approvals.
l We recommend overestimating tax and shipping amounts if you cannot provide an exact
match for costs. Google performs routine checks for merchant listed taxes and shipping
costs, verifying the amounts best match actual calculations from your storefront. If the
Google defined amounts are lower than your actual costs, Google may disapprove of the
products and/or account.
l Your account may encounter errors and issues due to violations. For more information on
account issues and suspensions, see Google's Understanding account suspension for policy
violations.
l Review and resolve your account errors quickly as possible. Your GMC account must be
approved to continue and complete product approvals and campaigns. If your account is in
error, all approvals are placed on hold and campaigns stop running.
Product Management
l If you exceed your Google quota (default is 150,000) for total synced line items (all items in
your product feed for all countries), you will receive an account error of too many products.
For example, if you sell and promote a product across three countries, the total number
counts against your total. Magento cannot extend or affect this quota. To increase your
l Check for and remove excessive numbers of invalid products to keep your synced product
amounts within your allocated quota.
l Consider adding product expiration dates to cycle through products on Google and stay
within your allocated quota. When the expiration is reached, the product automatically
deletes from Google. The default and maximum expiration date is 30 days after product
addition or update to Google.
l If you save price changes to products, or remove products, Magento immediately sends
those updates to Google. You should see the updated prices and removals within an hour
after saving changes. This is separate from product approval status checks with Google.
l Ensure your products prices and availability (in or out of stock) match between your online
storefront and GMC account. The quantity can differ and does not affect approval. Google
uses the Magento Regular Price and Special Price. See Google's Troubleshooter: Preemptive
product disapproval (price and availability).
l Consider not selling products that require personalization or customization during checkout.
See Google's Troubleshooter: Personalized goods.
l Determine if your products require a GTIN or Unique Product Identifier using Google's
decision form.
Campaigns
l Smart Shopping Campaigns have a learning period of two weeks for the Google AI to
optimize performance of your ads. Every time you edit and modify a campaign's budget or
assigned products, Google requires another two week re-learning period.
l If you have submitted product data for the first time or significantly updated existing data
in your GMC account, Google may take up to two business days to review the new data. As
a result, products in your campaigns may take time to also update.
l To better understand Google Ads issues, see Google's Fix issues with a Shopping campaign.
l Plan your campaigns and keep track through the Google Shopping ads dashboard. All
campaigns are manually created and ended through the Magento Admin. Magento does not
support scheduled campaigns at this time.
l You can create many campaigns to prepare for different seasons and promotions, pausing
them until ready to cycle the campaigns.
l Google serves and runs ads in all languages you configured when claiming and verifying
your URL. This may increase your costs for running ads.
This guide walks you through the entire onboarding process of setting up your accounts
including Magento web account, Google Merchant Center (GMC) account, and Google Ads
account. With your accounts created, your account and products start the Google approval
process. You do not need to create your accounts prior to onboarding.
Turn off pop-up blockers in your web browser. Some browsers may include pop-up blockers by default
(like Chrome). You cannot complete onboarding with pop-up blockers enabled.
Your progress through the onboarding process will not be saved until you tap Complete Setup. We
recommend completing all of these instructions to fully save your configurations.
Invalid API key error? You should have a valid API key to start onboarding. If you receive an
invalid key error, follow these instructions to update your API key. You only need to add this key
once.
Step 2: Creating GMC Account This leads you through a 4 step process to create a
new Google Merchant Center account.
When complete, this guide provides next steps to manage your products and kick off
campaigns!
Have questions? Check out the Google Shopping ads Channel FAQ and best practices topics
to better understand Google and Magento integrations. You can also perform a search for Google
Shopping ads in the Magento Help Center for additional troubleshooting topics.
If the key is missing, invalid, or expired, you will need to update the Google API key The
following instructions help you update your key and continue onboarding.
If your API key is invalid, the following screen displays to walk through the process.
2. Tap Sign in to log into your Magento web account. A new tab opens with Magento Accounts
with the Api Portal tab open displaying the key.
You may need to login with your Magento web account credentials. If you need to create an
account, visit here and register. This account should be part of your company or business.
3. To create a new key, enter a description like "Google Shopping ads" and tap Add.
5. Return to the Magento Admin tab and tap Add tbe key on the Google welcome screen.
A store configuration page opens to Stores > Configuration > Services > Channel.
6. In the Google Shopping ads section, paste the key you copied for API key.
8. On the Admin sidebar, tap Marketing. Then under Advertising Channels, tap Google
Shopping ads. Magento verifies and validates the entered API key, continuing with
onboarding.
Continue to Step 1
You must link your Magento web account that you used to get your API Key with your Google
account.
If you see a message requiring a Google API Key, see Verifying the Google API Key.
Your Google account is a general or business specific account for adding Google services and
additional account for Merchant Center and Ads.
l If you already have a Google account, you'll need your Google log-in credentials for the
linking process.
l If you don't already have a Google account, go to accounts.google.com and tap Create
account. Follow the prompts to create a new Google account. Make note of your log-in
credentials used to create your account. You'll need them for the linking process. When your
account has been set up, continue with the steps below to sign in.
We recommend using a Google account associated to your business or company. This Google
account will be the primary owner (admin) of the Google Merchant Center and Google Ads
accounts you set up in this integration process. It will also have payment methods and
complete purchases for Google Ads services for your company or business.
Helpful tips for onboarding! Turn off pop-up blockers in your web browser. Some browsers may
include pop-up blockers by default (like Chrome). You cannot complete onboarding with pop-up
blockers enabled.
3. In Sign in with Google, enter your Google account credentials (email address or select an
account), and complete signing in.
You may need to enter an authenticator if added to the account during creation.
With your Magento web and Google accounts linked, you can create a Google Merchant Center
(GMC) account and complete configurations for your products. See the best practices topic for
onboarding tips.
Each GMC account can be associated with one storefront URL. If you have more than one storefront URL,
you will create a GMC account for each of your store URLs. See Google's Set up a multi-client account.
If your storefront URL is already verified and claimed by another GMC account, you must unclaim any
URL that is already claimed for another GMC account before continuing with account creation.
Important! Your progress through the onboarding process will not complete until you tap Complete
Setup. We recommend completing all of these instructions to fully save your configurations, create
your GMC account, and send the URL to Google to start URL claiming and verification.
URL Verification Select the Website URL to associate with the new
GMC account. Your website URL will be verified and
claimed by Google.
To create your account, you need to read and accept the Google Merchant Center Terms of
Service and policies on Prohibited Content.
We recommend paying close attention to the policies and details for restricted content. Google
has specific requirements and guidelines for Adult, alcoholic, copyrighted, gambling-related,
healthcare-related, and political products. If you sell Adult products, we guide you through the
process of identifying these products during this onboarding process.
1. Select the I have read and agree to all terms of service checkbox.
2. Tap Next.
Continue to Step 2
URL Verification
Step 2 of 4 for GMC Account Creation.
In this step, you will select your website URL to associate to the new Google Merchant Center
(GMC) account. The selected site URL will be submitted to Google to be verified and claimed.
This URL verification identifies you as the authorized owner of your storefront URL (domain).
We recommend reviewing Google's Verify and claim your website URL.
Magento attempts to automatically verify and claim your site URL after submission. If
Magento is unable to verify and claim the URL automatically, it displays a notification that
site failed to claim.
If your storefront URL is already claimed to a GMC account, you must unclaim it before it can
be verified and claimed by another GMC account. We recommend that you unclaim any
storefront URLs that may be already linked to a GMC account.
You can manually verify and claim your site through your GMC account and update the site
information for your Magento store.
l Website URL: When integrating your store with Google, you select 1 website URL. Repeat
onboarding to create new GMC accounts and add another URL.
l Store Views: Add store views to add product feeds through Google for locales. You can
add multiple store views with a different language selected per view for international
storefronts. If you add store views in languages not configured in your Magento backend, the
ads will only contain product data from your Magento catalog. Additionally, each store
views creates a separate feed in GMC. If a product has errors, you may see that error
reported for each store view. For example, if you have 3 store views, 3 errors may display for
the same product (one for each view).
Each GMC account can be associated with one storefront URL. If you have more than one storefront URL,
you will create a GMC account for each of your store URLs. See Google's Set up a multi-client account.
1. For Website URL, select the storefront URL you want to associate with this GMC account.
2. Add the store views for your URL selecting a view name, country, and language for each
Website URL. You can add multiple store views with a different language selected per view for
international storefronts.
b. Select the Country of origin, used for shipping products and locale.
Google serves and runs ads for all the languages you add in this step. This may increase your
cost for running ads. You may want to limit your supported languages when first onboarding and
add languages later so you can estimate ad costs for international customers.
3. Enter a Google Store Name to identify this store URL and views in your GMC account. This
value is used and displayed in Google Ads.
Continue to Step 3
To provide the best estimate of taxes, shipping, and grand totals for your customers, select the
closest matching amounts for shipping and tax costs. Due to the complexity of shipping and
taxes, you may want to enter shipping or tax settings through the Google Merchant Center
(GMC). Your GMC account has extensive options to help you find the right calculations needed
for your store. You must complete onboarding then configure values in your GMC account
before Google approves your products.
These settings affect the displayed costs in your Google ads. As customers review ads, Google
auto-detects their location, matches ads for them, and displays the calculated costs of product
price, shipping, and tax. For example, searching for shoes and hovering over these sneakers, we
see the seller provides free shipping and no taxes.
Helpful Tips!
We recommend overestimating amounts if you cannot provide an exact match for costs. Google performs
routine checks for merchant listed taxes and shipping costs, verifying the amounts best match actual
calculations from your storefront. If the Google defined amounts are lower than your actual costs, Google
may disapprove of the products and/or account.
l To assign a flat shipping rate for all your products, select Use a flat rate for all orders and
enter an amount per country listed. To set free shipping, select this option and enter 0 for
the flat rate.
l To configure your shipping costs in Google Merchant Center, select I will set this up on
Google Merchant Center.
If you select this option and your country's required shipping costs, you may receive an account
error until you configure this setting in Google Merchant Center.
l If you are operating inside of the United States, select Use auto tax estimation (U.S. Only).
If you only sell and ship to some states in the US, select the states where you operate from
the list or by entering the name. Google provides estimated taxes based on the address of
customers and your configurations. For details, see Google's Set up tax settings (US only).
l If you are operating out of a country that uses VAT, or have no nexus in the United States,
select Don't configure tax/VAT is included in my product price.
Continue to Step 4
Attribute Mapping
Step 4 of 4 for GMC Account Creation.
Finally, map your Magento attributes with Google attributes. This attribute mapping will sync
your product details to Google's product feed format. Once you complete this step, all of your
products will be sent to Google with this mapping.
For more information on attributes and data, see About Google and Magento Catalogs.
This step can take additional time to complete. You may have an option to create attributes in
your Magento catalog for a few of these settings. When you complete this step, the attributes
are added and may require additional configurations after creating the account. You must
complete this step to create your Google Merchant Center account. You can edit these settings
at any time after completion.
For more information about Google's product attributes, see Google's Product data
specification.
Bulk resolve product errors: If you have a large number of products with the same error, you
may be able to solve it by creating a Magento attribute, configuring it for your products, and
mapping it to one of the following Google attributes.
Multiple Attributes
When configuring attributes, you can map multiple Magento attributes to a Google attribute. If
each attribute has a value, the first mapped attribute takes priority. For example, If you use
both EAN and UPC numbers in your Magento catalog, select both in the GTIN product
attribute field. If a product in your catalog has an EAN of 456 and a UPC of 789, the product
will use the UPC if it was selected first.
An additional Identifier Exists attribute is available for identifying new products without
GTIN and brand or MPN and brand.
For best practices, see Google's Tips to optimize your product data and the following best
practices:
1. Required. For Google title, select Magento "Product Name". This is the name of the product to
display in your ads.
2. Required. For Google description, select Magento "Description". This displays to customers
when looking at your products through Google Ads.
3. For Google Category attribute, select the option that best matches your catalog:
l If you want to associate all products sold on Google with one Google Category, select I sell
only one category of products and I do not use Magento attributes. Select the category
from the extensive list. For example, if you sell only clothing, you could select Apparel &
Accessories > Clothing. For a list of categories, see Google's google_product_category:
Definition.
l If you use a Magento attribute to signify Google categories, select I sell multiple categories
of products and I use Magento attributes. Select all Magento attributes from the drop-down
field list, or begin typing to filter and select attributes. Add all attributes matching products
you will sell through Google.
l To create new Magento attributes to associate to your catalog, select I want to create a new
Magento attribute. The new attribute will be added to your products. You will need to add
values for the attribute per products to complete account creation.
4. For Google condition, select the option that best matches your product condition(s). For
details, see Google's condition: Definition.
l If all of your products fall under one condition, select The condition of all products in my
catalog is the same. Select the condition, such as new.
l If you use specific Magento attributes for conditions, select I use Magento attributes to
specify the condition of my products. Select the Magento attributes that best match the
Google attributes for New, Refurbished, and Used. Then select and map all Magento
attributes applicable per Google condition.
5. For Google brand, select the Magento brand attributes assigned to your catalog. This attribute
is not required for all products. To increase sales for products you sell with associated brands,
we highly recommend configuring and selecting brands. For examples and best practices, see
Google's brand: Definition.
6. Select the GTIN (Global Trade Identification Number) types for your products, typically
assigned by manufacturers. This code is typically a code including UPC, EAN, JAN, ISBN, or
ITF-14. To find your GTIN, see Google's Find a GTIN.
7. Select the mpn (Manufacturer Part Number) for your products, typically assigned if your
product does not have a GTIN. For details, see Google's mpn: Definition.
8. Select the Magento attribute that identifies any new products without a gtin and brand or mpn
and brand. For details, see Google's identifier_exists: Definition.
l If all of your products do not have these settings, select All my products don't have
GTIN and brand or MPN and brand.
l If you use specific Magento attributes for these new products, select I use Magento
attributes to identify products that don't have GTIN and brand or MPN and brand. Select
the Magento attributes that identify these products.
1. For Google Age Group, select the attributes that best match your catalog. For details, see
Google's age_group: Definition.
l If all of your products fall under one age group, select The age group of all products in my
catalog is the same. Select the age group.
l If you use specific Magento attributes for age groups, select I use Magento attributes to
specify the age group of my products. Select the attribute(s). Then select the values that
best match the Google attributes for Newborn, Infant, Toddler, Kids, and Adults.
2. For Google Gender, select the attributes that best match your catalog. For details, see Google's
gender: Definition.
l If all of your products fall under one gender, select The age group of all products in my
catalog is the same. Select the gender.
l If you use specific Magento attributes for gender, select I use Magento attributes to specify
the gender of my products. Select the Magento attribute. Then select the values that best
match the Google attributes for Male, Female, and Unisex.
3. For Google Color, select Magento attributes for any colors you use such blue, red, white, black,
green, and so on. For details, see Google's color: Definition.
4. For Google Size, select Magento attributes for any genders you use such as extra-small,
medium, large, extra-large, or numerical sizes like 16/32. For details, see Google's size:
Definition.
If you use a Magento attribute to indicate adult-only products, select that attribute.
If you have adult-only products, but do not use a Magento attribute, complete onboarding.
Then create an attribute, add it to products, and set the value. Finally, update the attribute
mapping for Adult-Only with the new attribute.
l Magento sends all information you configured and entered during onboarding to Google.
l Google immediately creates the GMC account and begins the process to verify and claim the
URL.
The verify and claim process can take a few hours. Check the GMC Account section of the
dashboard to check the status. If automated claim is unsuccessful, see Manually verify and
claim a site URL.
l Once your URL is claimed and verified and if you have no account errors, Google begins
reviewing and approving your synced products. These products become your Google
Merchant Center catalog.
If Magento has an issue when creating attributes, a message may display. To resolve, see Editing
Attribute Mappings.
With your Google Merchant Center (GMC) created and products in-progress for approval,
create a Google Ads account and complete your first Google Ads Smart Shopping campaign.
Sorry, but the Google Shopping ads Channel implementation cannot support using an existing account.
You must create a new Google Ads account.
Creating Campaigns Optional. Create your first campaign as the last step
of onboarding, or tap skip to create a campaign
later. If you skip creating a campaign, you should
still add an Ads payment method and update
settings.
You should start in the process after creating your GMC account. If not, tap Create Ad
Campaign.
To create your account, you need to read and accept the Google Merchant Center Terms of
Service. We recommend reviewing Google's Shopping ads policies and Payment methods &
terms of service finder.
2. Tap Continue.
Continue to Step 2
Account Settings
Step 2 of 2 for Ads Account Creation.
l Set your country and timezone in the Google Ads Account Settings page. Currency
automatically populates when you select a country.
2. The Currency automatically sets for your store based on the country you selected. You may
update this setting. For example, if you select United States, it sets the currency as USD for
US Dollar.
Important:Once you specify a currency and create your account, you cannot change the currency.
You must also add a payment method and billing settings in the same currency.
3. For Timezone, select the timezone for your store's region. The timezone you select affects all
store data. For example, reports based on segments of time will generate different results
depending on the timezone associated with the account.
5. A confirmation message displays. If the settings are correct, tap Confirm Settings. If you need to
modify settings, tap Cancel to return to Account Setup.
6. The Create a Smart Shopping Campaign page opens. Complete the steps below before creating a
campaign.
Don't forget! You must activate your ads account, configure payment methods in your Google Ads
account, and update settings in Magento for your account to go live. If you forget adding a payment
method or updating settings, you will see a reminder message in the Magento Admin.
2. Locate the Google Ads invitation and click the link to activate the account.
1. In a new web browser tab or window, open your Google Ads account
2. In the Google Ads section, select the checkbox for Payment method configured. Any payment
method banner notifications will end. Your active campaigns publish and run with an
approved account and products.
Onboarding complete!
Next steps:
l Google has guidelines and policies to determine if an account is approved: Google's Terms of
Service and policies on Prohibited Content.
l Ensure your product catalog does not exceed your account product maximum. Google
allows you to sync and sell up to 150,000 products from your Magento catalog. If you
attempt to sell more than 150,000 unique products, Google will disable and reduce the
number of active products available. To increase your limit, contact Google with this form.
l When verifying and claiming your URL, Magento attempts the claim process up to five
times within an hour after submission. If the URL is not claimed within five attempts,
Magento provides a notification with more information.
l Always check back on your Account and Product Errors to resolve issues. We recommend
reviewing and resolving product errors as they can cause account disapprovals. Magento
performs validation immediately, listing issues in the Product Errors. Google performs
revolving checks on your product updates to complete reviews for corrected and added
products.
l After onboarding completes, we check for product approval and account status with Google
every 30 minutes for the first 72 hours of your integration. After the first 72 hours, Magento
checks product and account status once every 24 hours.
Have questions? Check out the Google Shopping ads Channel FAQ and best practices topics
to better understand Google and Magento integrations. You can also perform a search for Google
Shopping ads in the Magento Help Center for additional troubleshooting topics.
Google Store Name The name entered when creating your GMC account for your
URL, associated to your Magento store. See Google's About your
store name.
Claim Status The current verification and claim status of your site URL. You
must have a claimed and verified URL to receive account
approval. See Google's Troubleshooting your URL verification
and claim.
Account Status The current status of your GMC account with Google. You must
have an approved account to get your products approved and
run ad campaigns.
Products Status The current status of your products associated and mapped to
your GMC account. Approved products meet Google product
data specifications and Shopping Ads policies. If you sell
products of an Adult-Only nature, you must also adhere to
Google's Adult-oriented content policies.
OPTION DESCRIPTION
Review Google's Understanding account suspension, best practices, and troubleshooting for
additional information.
After onboarding completes, we check for product approval and account status with Google
every 30 minutes for the first 72 hours of your integration. Google may require up to 10 days to
complete reviews. After the first 72 hours, Magento checks product and account status once
every 24 hours.
2. In the GMC Accounts table, locate an account with Account Status of "Disapproved". In the
Actions column, tap Views Details.
Account Disapprovals
4. For each issue, tap Read Google guidelines in the Actions column. Complete any changes
required to resolve the issue.
Depending on product or account errors, you may need to update some or all of these settings.
Have questions? Check out the Google Shopping ads Channel FAQ and best practices topics
to better understand Google and Magento integrations. You can also perform a search for Google
Shopping ads in the Magento Help Center for additional troubleshooting topics.
l Remove a GMC account
Settings Overview
The settings page includes:
l Google Ads account associated to your integration including an option for Payment Method
Account Settings
Google Store Name The name entered when creating your GMC account for your
URL, associated to your Magento store. See Google's About your
store name.
Google Merchant Center The unique ID generated by Google for your GMC account.
Account ID
OPTION DESCRIPTION
Edit Shipping and Modify shipping and tax settings for the
Tax account. if you select options to set
information in Google, make sure to access
and update those settings in your
GMC account.
Google Ads
OPTION DESCRIPTION
Account ID Linked Google Ads unique account ID, generated when creating
your account.
Payment method Select this option when you have added a payment method to
configured your Google Ads account.
Configure Payment Link to access payment methods in your Google Ads account.
View Google Ads Account Link to access your Google Ads account.
3. For a specific GMC account, tap Select in the Actions column. Select an option.
URL Setting
l To assign a flat shipping rate for all your products, select Use a flat rate for all orders and
enter an amount per country listed. To set free shipping, select this option and enter 0 for
the flat rate.
l To configure your shipping costs in Google Merchant Center, select I will set this up on
Google Merchant Center.
If you select this option and your country's required shipping costs, you may receive an account
error until you configure this setting in Google Merchant Center.
3. Update your tax settings or select a new option. For complete details, see Shipping and Tax.
l If you are operating inside of the United States, select Use auto tax estimation (U.S. Only).
If you only sell and ship to some states in the US, select the states where you operate from
the list or by entering the name. Google provides estimated taxes based on the address of
customers and your configurations. For details, see Google's Set up tax settings (US only).
l If you are operating out of a country that uses VAT, or have no nexus in the United States,
select Don't configure tax/VAT is included in my product price.
To remove a GMC account:
1. On the Admin sidebar, tap Marketing. Then under Advertising Channels, tap Google
Shopping ads.
2. Tap Settings. A list of all GMC and Ads accounts and settings display.
4. Tap Remove.
2. Tap Settings. A list of all GMC and Ads accounts and settings display.
3. In the Google Ads section, review the linked account information. The linked ID and Visit
Google Ads Account will take you to your Google Ads account.
4. To update the payment method, tap Configure Payment. Update your billing information with
Google.
5. If you have added and updated your payment method, make sure to check Payment method
configured. Magento requires this option checked.
When creating a GMC account in Google Shopping ads Channel, Magento attempts to
automatically claim your store URL(s) after submission, but already-claimed sites will fail this
automated process. Already-claimed sites must be unclaimed from one GMC account before
claiming to another GMC account, as Google allows only one website URL to be associated with
one GMC account.
Claimed URLs
5. Review the listed URLs on your account to ensure the claims are removed.
Magento attempts to automatically verify and claim your site URL after submission to Google.
If Magento is unable to verify and claim the URL automatically, a notification will display and
state that the site failed to claim.
A common reason for a site to remain in "Unclaimed" status is that the site has already been
claimed by another GMC account. If you think this might be the case, you must unclaim the
site before it can be claimed by your new GMC account. You can then manually verify and
claim your site.
l Logging into your Magento admin and updating your store configuration
2. Select Business Information, then tap About your business. In the Website section, tap
Unclaimed for the website you want to claim.
3. The Other ways to verify and claim your website URL section displays. Select and copy the
meta tag text provided in the field.
4. In a separate browser window, log into your Magento admin. Tap Content in the admin side
bar. Under Design, tap Configuration.
5. In the Website column, locate the store for which the URL is to be claimed. Tap Edit in the
Action column.
6. Tap HTML Head. In the Scripts and Style Sheets field, paste the meta tag text you copied in
your GMC account.
8. In the GMC browser window, refresh your browser window. Tap Verify, and then tap Claim.
On the GMC Accounts dashboard in Google Shopping ads, the Claim Status column for the Site
URL will update to "Claimed and Verified."
Have questions? Check out the Google Shopping ads Channel FAQ and best practices topics
to better understand Google and Magento integrations. You can also perform a search for Google
Shopping ads in the Magento Help Center for additional troubleshooting topics.
Managing Products
Google Shopping ads provides detailed status and updates for your Google Merchant Center
(GMC) products. After you complete onboarding and if your account status is not disapproved,
products matching your attribute mapping begin syncing to your GMC account. Approved
products display in ads depending on campaign settings.
l Added a payment method to Google Ads and updated settings (see Account Settings)
l The integration supports all Magento product types excluding gift cards, grouped products,
simple products with required options, and bundled products with dynamic pricing.
l Google has guidelines and policies to determine if a product is approved: Google product
data specifications, Shopping Ads policies, and Adult-oriented content policies.
l Ensure your products prices and availability (in or out of stock) match between your online
storefront and GMC account. The quantity can differ and does not affect approval. Google
uses the Magento Regular Price and Special Price. See Google's Troubleshooter: Preemptive
product disapproval (price and availability).
l Always check back on your Account and Product Errors to resolve issues. Magento performs
some validation immediately, listing issues in the Product Errors. Google performs revolving
checks on your product updates to complete reviews for corrected and added products.
l After onboarding completes, we check for product approval and account status with Google
every 30 minutes. Google may require up to 10 days to review all products initially. All new
products may take up to 72 hours for review and approval.
This is the prerelease version of Amazon Sales Channel. Content in this version is subject to
change.
Google Store Name The name entered when creating your GMC account for your
URL, associated to your Magento store. See Google's About your
store name.
Claim Status The current verification and claim status of your site URL. You
must have a claimed and verified URL to receive account
approval. See Google's Troubleshooting your URL verification
and claim.
Account Status The current status of your GMC account with Google. You must
have an approved account to get your products approved and
run ad campaigns.
OPTION DESCRIPTION
Products Status The current status of your products associated and mapped to
your GMC account. Approved products meet Google product
data specifications and Shopping Ads policies. If you sell
products of an Adult-Only nature, you must also adhere to
Google's Adult-oriented content policies.
and resolve your account issues. When you open an error, all products sharing that error are
listed with additional information and a link to Google policies and instructions. Click through
each product to actively edit and resolve those issues through the Magento Admin.
l As you save changes, product data automatically syncs to Google using a cron job. Reviews
may take additional time to initiate and complete. After onboarding completes, we check for
product approval with Google every 30 minutes. Google may require up to 10 days to review
all products submitted in your onboarding process.
l You may see multiple product issues for the same product. Each store view you added
during onboarding created a separate feed in GMC. If a product has errors, you may see that
error reported for each store view. For example, if you have 3 store views, 3 errors may
display for the same product (one for each view).
l If you have a large number of products with the same error, you may be able to solve it by
creating a Magento attribute, configuring it for your products, and mapping it to a Google
attribute. This bulk resolves errors.
Review Google's Product data specification to best understand the product data used by
Google. The following information and our best practices and troubleshooting may help resolve
issues.
l Ensure your products prices and availability (in or out of stock) match between your online
storefront and GMC account. The quantity can differ and does not affect approval. Google
uses the Magento Regular Price and Special Price. See Google's Troubleshooter: Preemptive
product disapproval (price and availability).
l Consider not selling products that require personalization or customization during checkout.
See Google's Troubleshooter: Personalized goods.
l Determine if your products require a GTIN or Unique Product Identifier using Google's
decision form.
l Images may not display correctly due to a number of possible issues including lag in
updating files, caching of old images after you provide new images, images use unsupported
formats (JPG, PNG, GIF are supported), image URLs have changed or are incorrect,
redirection issues, file size issues, and a few other possibilities. See Google's Fix images that
aren't displaying.
1. On the Admin sidebar, tap Marketing. Then under Advertising Channels, tap Google
Shopping ads.
2. In the GMC Accounts table, locate an account with Product Status of "Disapprovals". In the
Actions column, tap Views Details.
Product Disapprovals
5. The Resolve Errors page displays with issue information, a link to Google guidelines, and a
list of products disapproved for the issue.
Immediately after onboarding, you may encounter an issue creating new Magento attributes. If
you selected to create a Category, Magento attempts to create an attribute after onboarding. If
an issue occurs, see the Resolve Errors with Attribute Mappings section.
As your catalog matures and business expands, attribute sets and options may enhance to
better define your products. This also helps to bulk resolve Google disapprovals. If you want to
add to or modify existing Magento attributes associated per GMC attribute, see the Update
Attribute Mappings with Google section.
Have questions? Check out the Google Shopping ads Channel FAQ and best practices topics
to better understand Google and Magento integrations. You can also perform a search for Google
Shopping ads in the Magento Help Center for additional troubleshooting topics.
If you create an Adult-Only attribute to identify adult-oriented products, it must support "True" and
"False" for the value. Google only accepts "True" or "False" for adult attributes.
1. On the Admin sidebar, tap Marketing. Then under Advertising Channels, tap Google
Shopping ads.
2. Tap Settings. A list of all GMC and Ads accounts and settings display.
3. For a specific GMC account, tap Select in the Actions column. Select Edit Attribute Mapping.
Attributes you mapped during onboarding display for the following values. Update settings as
needed.
Category attribute l I sell only one category of products and I do not use Magento
attributes – If you do not use a Magento attribute to indicate
your product category, choose a Google category that best
matches your products.
Brand Your product’s brand name. This helps identify your product and
is shown to users who view your ad. It is required for any
product with a clearly associated brand or manufacturer.
Identifier Exists Magento attribute(s) that identifies any new products without a gtin
and brand or mpn and brand. For details, see Google's identifier_
exists: Definition.
l If all of your products do not have these settings, select All
my products don't have GTIN and brand or MPN and brand.
Managing Ad Campaigns
Simplify your ad campaign management, increase your sales, and expand your reach with
Smart Shopping campaigns. Smart Shopping campaigns combine, your existing product
catalog with Google’s machine learning to show a variety of ads across different ad networks.
Networks include the Google Search Network, the Google Display Network, YouTube, and
Gmail. Smart Shopping campaigns feature both Product Shopping ads and display ads
(including Remarketing Ads and Similar Audiences). To learn more about Google Ads, see
About Google Merchant Center and Ads.
l Added a payment method to Google Ads and updated settings (see Account Settings)
Campaign Basics
Understanding the basics and best practices helps you get ahead with campaigns:
l Edit the campaign anytime to update settings for Paused and Active campaigns.
l The displayed date matches the campaign creation date. If paused then moved to active
again, the new active date displays. When you end a campaign, the date clears.
l Create, pause, and end your campaigns directly through the dashboard Actions menu.
Google Shopping ads Channel does not provide scheduling features.
l Campaigns immediately run with approved products in the Google catalog. The ads include
newly approved products as they are processed.
l Campaigns can have the following status: Active (running), Paused (not running), and
Ended (completed and not running).
l You can select all or a filter list of products in your Google catalog. The integration supports
all Magento product types excluding gift cards, grouped products, simple products with
required options, and bundled products with dynamic pricing. Google also recommends not
selling products requiring customization or personalization.
Have questions? Check out the Google Shopping ads Channel FAQ and best practices topics
to better understand Google and Magento integrations. You can also perform a search for Google
Shopping ads in the Magento Help Center for additional troubleshooting topics.
Ad Campaign Dashboard
When accessing Google Shopping ads, the dashboard provides a list of all ad campaigns for a
date range. At a glance, learn more about the following:
Ad Campaigns Dashboard
Campaign Information
OPTION DESCRIPTION
Campaign Name Entered name for the campaign.
Site URL The website URL targeted by the ad campaign. This identifies
your storefront and product catalog.
Daily Budget The set average daily budget for spending on ads.
OPTION DESCRIPTION
Cost The actual amount to spent on the campaign for the time range.
Launch Date The date when the campaign was created. Ended campaigns do
not have a listed date.
Status Supported Google Ads status for the campaign. For more
information, see Google's About campaign status.
OPTION DESCRIPTION
Creating Campaigns
Google Shopping ads supports Smart Shopping ads. Smart Shopping campaigns help simplify
your campaign management, maximize your conversion value, and expand your store's reach.
An important aspect to creating and maintaining your ads is the daily budget. Setting a budget
indicates the average maximum amount you want spend for displaying and promoting the
Smart Ads per day. Google has intelligent tracking and algorithms to evaluate the popularity of
your products, ad displays and click-throughs, and much more. If an ad is popular with
significant click-throughs, Google may promote the ad more, possible spending more of your
budget. The amounts balance, never exceeding your average, and rolling over amounts not
spent from one day to the next.
To learn more about Google Ads budgets, see Google's Daily budget: Definition and Set a
budget for your campaign.
3. If you have multiple GMC accounts, locate and Select Your Google Merchant Center account.
4. Select the country of sale for your campaign for the Country to advertise in. If the website store
views have product data for that country and locale, content displays in that language.
6. Enter a Daily Budget to set the average maximum amount you want to spend on your ads per
day. If you do not spend this entire amount in a day, the remaining amount rolls over to the
next day.
7. For Select Products for the Campaign, select your products to sell with Google through this
campaign:
l To add all of the GMC products to this campaign, tap Select all products in my Google
Merchant Center catalog.
l To add a specific set of GMC products matching attributes and categories to this campaign,
tap Select Products Using Filters. Select from the drop-down list or start typing to add
filters for brand or categories.
9. The Review Campaign page lists all aspects of your ad campaign, including, review the
details of your campaign.
l If everything looks accurate, click Submit Campaign. This publishes the campaign on Google.
It is active but not running ads until your account and products are approved. When
published, the campaign displays in the list on the dashboard.
Country to advertise in Specifies the country of sale for the campaign. This setting
limits which products from your Merchant Center inventory
can be advertised in this campaign. It filters products based
on the target country associated with the products.
Campaign Name Specifies the Google Ads campaign name, which can be
changed later.
Daily Budget Sets the approximate limit for how much you want to pay for
your ads for a specific campaign, on average, per day. If you
do not spend the entire amount each day, the remaining
amount rolls over to the next day.
Select Products for this Determines how products are included in the Google Ads
Campaign campaign. The products used come from the approved products
in the Google catalog.
Managing Campaigns
Maintaining and running your campaigns may require editing settings such as targeted
products and allocated daily budgets. Before making changes, be advised that Smart Shopping
Campaigns have a learning period of two weeks for the Google AI to optimize performance of
your ads. Every time you edit and modify a campaign's budget or assigned products, Google
requires another two week re-learning period. If you have submitted product data for the first
time or significantly updated existing data in your GMC account, Google may take up to two
business days to review the new data. As a result, products in your campaigns may take time
to also update.
Depending on conversions and seasons, you may also want to pause or end campaigns to run
others, without constantly editing the same campaigns. All campaigns require manual actions
to pause, enable (or run), and end. You can create many campaigns to prepare for different
seasons and promotions, pausing them until ready to cycle the campaigns.
Have questions? Check out the Google Shopping ads Channel FAQ and best practices topics
to better understand Google and Magento integrations. You can also perform a search for Google
Shopping ads in the Magento Help Center for additional troubleshooting topics.
2. For a specific campaign, tap Select in the Actions column, then tap Edit.
FIELD DESCRIPTION
Select your Google Merchant Cannot be modified.
Center account
Specifies the Google Merchant Center account for the
campaign.
Campaign Name Specifies the Google Ads campaign name, which can be
changed later.
Daily Budget Sets the approximate limit for how much you want to pay for
your ads for a specific campaign, on average, per day. If you
do not spend the entire amount each day, the remaining
amount rolls over to the next day.
Select Products for this Determines how products are included in the Google Ads
Campaign campaign. The products used come from the approved products
in the Google catalog.
2. For a specific campaign, tap Select in the Actions column, then select an action.
ACTION DESCRIPTION
Enable Activates a campaign and begins running ads. The status sets to
Active.
3. The campaign status updates on the screen and syncs to Google. Depending on the action
selected, the campaign may require additional time to complete updating.
Campaign Reporting
As your ads run, Google tracks all clicked ads links through to converted sales. Aggregated
totals provide quick insight to your sales to determine the effectiveness of your ads, attractive
products and prices, and costs per ad. Google Shopping ads Channel provides two options for
reviewing your Smart Shopping campaigns through the Magento Admin or Magento Business
Intelligence.
Magento Reporting
When accessing Google Shopping ads Channel, the dashboard provides aggregated reporting at
the account level for the past 14 days (not including the current day). At a glance, learn more
about the following:
l Calculated aggregated reporting of all costs and sales collected for your Google Ads Smart
Shopping campaigns
l Campaign details and status for the entire run of the campaign
Ad Campaigns Dashboard
l Account performance
l Campaign performance
l Product performance
Conversion Reports
Getting started is easy. Complete an onboarding process to create an Amazon Seller Central
account and integrate with your Magento catalog to manage Amazon listings, orders,
inventory, and fulfillment. A central dashboard displays status updates for all store
integrations and listings. Reach new customers in the global Amazon Marketplace with
simplified and automated processes – all at little or none of the cost and labor of setting up a
new system.
After integrating your Amazon Seller Central account, Amazon Sales Channel enables you to
manage your accounts and syncs data between Magento and Amazon. Amazon Sales Channel
gives you the ability to create listings, manage promotions, set prices, and manage inventory
and fulfillment directly through the Magento Admin. These options include pricing rules that
monitor Amazon pricing for the same item and automatically adjusts your prices to be more
competitive.
This guide reviews some basic Amazon Seller Central information, the requirements for setting
up your Amazon Sales Channel, the onboarding and setup process, and the ways in which you
can use Amazon Sales Channel to manage your products and sales in the Amazon marketplace.
Managing Attributes
Amazon Sales Channel maps products between your
Magento catalog and Amazon using product attributes.
Learn more about creating, mapping, and managing those
attributes.
l Managing Listings
The integration connects Magento and Amazon to sync data between both platforms. Amazon
Sales Channel enables you to:
l Onboard and integrate one or more Amazon Seller Central accounts with Magento.
l Import and sync your existing Amazon listings into your Magento catalog.
l Create and manage Amazon listings for your Magento catalog products.
l Review and fulfill (ship) orders in Magento and Amazon, syncing order status and refunds.
l Review logs for analysis and errors for competitive prices, listing changes, and
communication issues.
Manage and review all of these features, account information, listings, orders, and more on the
Amazon Sales Channel Home central dashboard.
l Synchronize Amazon listing pricing to Magento catalog price (or alternate price attribute)
l Set a custom value for "available quantity" to display with listings to increase buyer urgency
Pricing Rules
With Amazon Sales Channel, you can:
l Create and manage pricing rules for everyday sale or seasonal promotions
l Create and manage intelligent pricing rules that will automatically adjust your product
pricing relative to other Amazon competitors (lowest Amazon competitor and Amazon Best
Buy Box price)
l Import your existing Amazon listings (products) and match to existing or create new
products in your Magento catalog
l Create overrides to set an individual price, handling time, condition, and seller notes
message
l Import and match your Amazon product attributes for automatic product matching with
your Magento catalog
l Set multiple search parameters to match Amazon listings to your Magento catalog
l Set extensive rules to determine which of your Magento products are eligible to be listed on
Amazon
l Implement quantity thresholds when importing Amazon listings into your Magento catalog
l Define which of your Magento website stores to associate with your Amazon orders for
importing and managing orders
l Review, cancel, and ship orders from Magento and/or Amazon depending on the selected
fulfillment
l Map your Amazon order status to custom status within Magento (optional)
l Review and manage order errors, resolving issues and connecting with customers
Reporting
With Amazon Sales Channel, you can review report information about:
l Amazon listings action log to review overall feed changes (price, quantity, etc.)
l Manage multiple Amazon Marketplace regions all from your Magento Admin
l Manage shipments from your product locations and Amazon fulfillment centers
Customer Management
With Amazon Sales Channel, you can build your Magento customer database by importing
customer data associated with your Amazon orders. Leverage and expand your marketing
potential through this expanded list of customers through your Amazon Marketplace listings
and Magento storefront.
Third-party sellers of any size can create an Amazon Seller Central account and use the Amazon
Marketplace to reach Amazon's global customer base. Once an account is created and active,
sellers can add and list products for sale, manage orders and inventory, and fulfill orders.
Amazon Listings
Amazon listings contain categories of information: Product Information and Listing
Information.
Product Information
Product information provides data common to every instance of the same product listed on
Amazon. For example, several sellers may list a particular brand of yoga pants on Amazon. The
general details about the product, such as the name and model number, are the same each time
the product is listed. When more than one seller contributes data to a product, Amazon
determines which seller's product information will be displayed on the product detail page.
Listing Information
Listing information provides seller-specific information about products. These details often
differ from other sellers' listing for the same product. For example, you may sell the same yoga
pants as another seller, but your item number, condition, price, or shipping method time may
be different. These details are unique to your listing for the product.
Amazon Fulfillment
Amazon offers two options for order fulfillment and shipping to third-party sellers:
l Fulfilled by the merchant (FBM): Third-party sellers store their own inventory. When a
customer places an order, the seller handles the packaging and shipping to the customer.
This option allows you to complete shipments through Magento or another third party.
Amazon Sales Channel supports both options, receiving and tracking these orders through the
Magento Admin. As you complete fulfillment, status updates automatically. For complete
details, see Fulfillment Workflows.
l Shipping policies
l Selling policies
To better manage and review your product catalog and sales through one location, Amazon
Sales Channel imports your Amazon listings into your Magento backend, continually syncs
with products and sales, and reports issues and trends. It supports integrations with multiple
Amazon Seller Central accounts, tracking all data through the single interface for multiple
storefronts.
Product Attributes
Magento manages catalog syncs with the use of product attributes to define product settings
and data. Amazon also uses attributes, to be mapped through onboarding. During pre-setup
tasks for Amazon Sales Channel, you will define additional Amazon attributes if needed to
ensure correct product mappings when importing your Amazon listings into your Magento
catalog. These attributes include UPC, EAN, ISBN, and ASIN (Amazon Standard Identification
Number). Through onboarding, products sync between Amazon and Magento catalogs using
your attributes, especially these. Proper mapping of your Magento and Amazon products
ensures a continual synchronization of product information, orders, and inventory.
If you do not have these attributes created or configured for your catalog, we recommend
adding a Magento Product attribute and values to your products prior to onboarding. Once an
Amazon attribute is imported, it can be used for search, navigation, price rules, and much
more. For more information on these attributes, see Amazon: What are UPCs, EANs, ISBNs.
and ASINs?
After onboarding, you can manage and update your product attributes and Amazon mappings
at any time.
Product Listings
An Amazon listing is a product page for every product you sell through the Amazon
Marketplace, displaying product descriptions, prices, images, and more mapped through
attributes. During onboarding, you can configure your Magento products can be automatically
published to Amazon listings. You can also import your existing Amazon listings by mapping
them to your Magento products.
When you have created a listing Magento products, they are submitted to Amazon for
approval. Most successful listings are approved within a few hours. If your listing is approved,
it will display in the Amazon Marketplace for immediate orders by customers. The Amazon
l Ready to List: Lists products meeting listing rules requirements and ready to publish to
Amazon.
l Inactive: Lists products not available on the marketplace due to being blocked for a specific
reason (such as branding issue), closed and requiring relisting, etc.
l Ineligible: Due to the listing rules, lists product that cannot be actively listed on the
marketplace (such as 0 quantity, sell dates, etc).
l Incomplete: Lists products missing required information. Update the product data for
another review.
l Ended: Lists product listings eligible for listing but manually removed from Amazon. You
can relist these products.
Syncing Data
Magento communicates product and order data between your Amazon Seller Central account
and the Magento backend. The constant updates provide a single source through Magento to
manage and maintain your inventories, fulfilling orders, tracking sales, and reducing overhead
and duplication of work. Reporting captures the latest data for tracking trends and resolving
communication issues caught between the two systems.
All syncing is managed by a cron job, set to update every five minutes.
l Amazon Sales Channel is powerful and can affect your Amazon listings by increasing or
decreasing prices, synchronizing product information (including available stock), and
adding, updating, and ending (deleting) listings. You should review your listings by status
during your setup and adjust your settings (listing settings, listing rules, pricing rules,
overrides, etc) before completing your store setup. These settings can also be modified after
setup, as needed.
l Amazon Sales Channel can set your pricing rules to automatically adjust your listing price.
Automated pricing safeguards include the Floor Price and Optional Ceiling Price features of
Intelligent repricing rules. Use of these safeguards helps ensure that your listing prices do
not go below your cost or above a defined price.
l Data syncing between Amazon Sales Channel and Amazon is controlled by your Magento
cron settings. Built-in throttling between Magento and Amazon help to ensure smooth and
efficient data transmission, but during high eCommerce traffic times (such as Black Friday),
Amazon’s systems may take longer than usual to update. It is recommended to set your
Magento cron to run once every five minutes.
l Amazon Sales Channel imports your Amazon order information. To manage your Amazon
orders in Amazon Sales Channel, you must ensure that your order settings are defined to
import and create a corresponding Magento order for each Amazon order. If this is not
defined, you will only be able to view your Amazon order information.
l All taxes for sales through Amazon are still managed and remitted via your Amazon Seller
Central account. In some states, Amazon is required to automatically collect and remit
taxes. For other states, sellers have the option of calculating taxes manually or
automatically. See Amazon: Tax Policies. You may be required to log into your Amazon
Seller Central account to view Amazon Tax Policy documentation.
Limitations include:
l Bundle, gift card, and grouped product types that are part of your Magento catalog are not
supported by Amazon Sales Channel for listing to Amazon.
l Amazon Sales Channel cannot create a listing for a product that does not have an existing or
previous Amazon listing. If a product does not already exist in Amazon Seller Central with
an ASIN, it must be added in Amazon Seller Central so that Amazon can assign the product
an ASIN. Once a product is added in Amazon and a listing is created, the listing can be
matched to your catalog in Amazon Sales Channel and synced.
Amazon Sales Channel supports the creation of multiple Amazon Sales Channel stores. For a
single Amazon Seller Central account that operates in the Amazon region that includes
U.S./Canada/Mexico, you will create three Amazon Sales Channel stores (one for U.S. sales, one
for Mexico sales, and one for Canada sales). Each of the three stores will define the region
during its setup and be integrated with the same Amazon Seller Central account. If you have
more than one Amazon Seller Central account, you could potentially have up to three Amazon
Sales Channel stores for each of your Amazon Seller Central accounts.
Amazon Sales Channel requires a Professional Seller account on Amazon Seller Central, in the North
America region. Amazon charges a monthly subscription and fees for selling. See Amazon: Choose your
selling plan.
Your progress through the onboarding process saves as you tap save options or Next through the steps.
Your integration is fully complete when you tap Complete Setup. We recommend completing all of these
instructions to fully save your configurations.
Until your account and integration is active, your status is "In Setup". If you access your integration to
edit settings and configurations, you return to onboarding with your currently saved configurations.
Your Amazon Sales Channel settings affect your Amazon listings. You can review your listings during
setup and make any changes before completing your setup and publishing your listings in Store Review.
You can also modify your Amazon Sales Channel settings after your setup is complete.
Verify Amazon API When accessing Amazon Sales Channel, Magento automatically
Key checks and validates the Amazon API key you have added in
your store configuration. If your API key has not been added or is
invalid, you will be prompted to add or update your Amazon API
Key.
Step 1: Store Integration The first step is to create an Amazon Sales Channel store and
connect your Amazon Seller Central account. You need the
primary log-in credentials for your Amazon Seller Central
account (the email or phone used to create the seller account).
Step 2: Listing Settings Configure the interaction settings between your Magento catalog
and Amazon listings. These listing settings include attribute
mappings between Magento and Amazon, fulfillment, quantity
thresholds, and more.
Step 3: Listing Rules Configure listing rules to define which Magento catalog products
are eligible to be listed on the Amazon marketplace. You have a
number of options to include and exclude products, for example
automatic creation of listings for new eligible products and
exclusion of existing Amazon products setting them to ineligible.
You select and configure the website for this integration in this
step.
Step 4: Listing With your listing rules finalized, review your Magento catalog
Preview products as Amazon listings.
Step 6: Pricing Rules Define pricing rules to automatically adjust your Amazon listing
prices, based on a beginning price source attribute. Additionally,
you can stack multiple rules and use intelligent pricing to adjust
your Amazon listing price based on competitors' Buy Box Price or
Lowest Competitor Price.
Step 7: Store Review Review all of your settings before launching your store. Until you
tap Complete Setup in Store Review, your store is in "In Setup"
status, and you can review and modify most of the settings
configured in steps 2-6. After you complete setup, you can access
your store and listing settings on the store's dashboard.
Pre-Setup Tasks
Before starting your onboarding tasks with Store Integration, you must ensure that your
Amazon Seller Central account and your Magento account are ready for the integration. To
achieve a successful integration and setup, we have outlined some required pre-setup tasks.
Every time you set up a new Amazon store, a list of set up tasks display. We recommend
reviewing and completing these tasks the first time you set up a store.
1. In the Admin sidebar, tap Marketing. Then in the Channels section, tap Amazon.
2. On the Amazon Sales Channel Home page, tap Setup Amazon Store.
3. Review and verify you have completed these tasks and configurations.
When you complete the pre-setup tasks and recommendations, you are ready to set up your
Amazon Sales Channel store through onboarding. Tap Begin Setup on the Pre-Setup Tasks
screen.
l For maximum performance, set Magento cron to run once every five minutes.
Amazon Sales Channel requires a Professional Seller account on Amazon Seller Central, in the
North America region. Amazon charges a monthly subscription and fees for selling. See
Amazon: Choose your selling plan.
It is also important to ensure that you have configured the following in your Amazon Seller
Central account:
l Ensure your return policy is as good or better than the Amazon return policy. See Amazon:
Return Policy
l Ensure your tax settings are configured. See Amazon: Tax Policies.
l Ensure that your shipping methods are configured accurately. To set up the shipping
methods that Magento will offer to customers to fulfill your Amazon orders, update the
Amazon: Shipping Settings in your Amazon Seller Central account.
To have the highest number of Magento products automatically match with Amazon listings,
we recommend creating a set of product attributes to your Magento catalog. Before you set up
your Amazon Sales Channel store, we recommend adding Magento product attributes to match
these Amazon attributes, for example: ASIN, EAN, ISBN, UPC, or GCID. See Onboarding:
Create a product attribute in Magento.
Additional configurations
Once your Amazon account is set up and active, there are several Magento recommendations
that will help streamline the Amazon Sales Channel onboarding process.
Review and note any products you don't want to list on Amazon.
You may not want some products to be listed on Amazon. Amazon Sales Channel has a listing
rule engine that is used to determine which products are eligible for publishing to Amazon.
Listing rules allow you to select subsets of products to be published (or not published) to your
Amazon Seller Central account, such as by category selection or by defining one or more
product attributes. Like Magento catalog or shopping cart price rules, product attributes used
for Amazon listing eligibility must be set to “Used for Promo Rule Conditions”.
To help facilitate error-free data transition during integration, we highly recommend setting
your Amazon region to "Inactive" status in Settings > Account Info > Vacation Settings. Refer
to Amazon: Listing Status for Vacations. Once your setup is complete, change the status back
to "Active" in Amazon.
These instructions detail how to create Magento attributes for Amazon ASIN and Amazon
Condition. We recommend creating additional attributes including Amazon EAN, Amazon
ISBN, and Amazon UPC. You may want to also create an Amazon Price attribute if you want to
use your Amazon listing price as a price source for pricing rules. These attributes are used when
configuring your listing and pricing settings during onboarding. They are also be used when
creating Amazon listings and when updating and syncing your Magento catalog with your
Amazon listings.
Catalog Search settings enable you to set matching search parameters that help to map eligible
Magento products with Amazon listings. Once mapped, Amazon activates actions related to
pricing, quantity, overrides, and order and product synchronization.
Defining these values increases the potential for exact matches, minimizing the need to
manually match product listings later. Adding the attributes as part of your onboarding Pre-
Setup Tasks, Amazon Sales Channel has a higher potential for automatically matching your
products during onboarding and syncs product data between Amazon and Magento after
onboarding.
If you only create the Amazon ASIN attribute (without adding ASIN values per product), your
Magento products may not automatically your Amazon listings will automatically. You can
manually match your products through Store Review. However, manual matching does not
create the data elements needed to share and sync your product data.
Important: If you manually matched a product and you need to update an ASIN, UPC, or other data
element for the product, you would have to update the data in both places, in your Magento catalog
and in your Amazon listing in your Amazon Seller Central account.
2. Tap Stores in the left-side menu. In the Attributes section, tap Product.
4. For Default Label, enter "Amazon ASIN" (the name for your attribute).
5. For Catalog Input Type for Store Owner, choose Text Field.
Although an Amazon ASIN is required to list a product on Amazon, some of your catalog products
may not be listed on Amazon.
2. Tap Stores in the left-side menu. In the Attributes section, tap Product.
4. For Default Label, enter Amazon Condition (the name for your attribute).
7. For Manage Options (Values for your Attribute), add each of your condition options.
l Good: Used
l Acceptable: Collectible
b. Tap to check the Is Default radio button for the option you wish to be the default selection.
c. In the Admin column, enter the text for the label of the condition you are adding (New,
Used, Used-Like New, etc.)
If the Amazon API key is missing, invalid, or expired, you must update your key. A message
displays prompting you to get an API key and to add they key to your Amazon Sales Channel
configuration.
1. On the Admin sidebar, tap Marketing. Then under Channels, tap Amazon.
If you need an to update your API key, the following screen displays to prompt you through the
process.
2. Tap Sign in. The Magento Accounts page displays in a new browser tab. If you are logged into
your Magento account, the API Portal section of the My Account page displays automatically.
If you are not logged it, you are prompted to enter your Magento username and password
before the API Portal tab displays.
If you need to create a Magento account, visit here and register. This account should be part of your
company or business.
3. API keys can be viewed and generated on the API Portal tab in your Magento account. If you
need to create a new API key, ensure the Environment drop-down is set to "Production." Then
enter a description like "Amazon Sales Channel" and tap Add New. The new key is generated
and displayed with the name you entered. Tap Copy to copy the new key.
4. With the new key generated and copied, return to the Amazon Sales Channel browser tab. On
the Welcome to Amazon Sales Channel screen, tap Add Key. The browser exits Amazon Sales
channel and displays the Magento Services tab in your store configuration page.
6. Tap Save Config. You can now return to Amazon Sales Channel.
Add your API Key in the Magento Services screen in your Store Configuration
7. On the Admin sidebar, tap Marketing. Then under Channels, tap Amazon. Magento verifies
and validates your API key and allows you to continue with setup.
If the verification screen displays again, repeat the process.
To begin, create an Amazon Sales Channel store and connect it to your Amazon Seller Account.
This integrates your Magento and Amazon accounts to share data, sync products, and more.
You need your Amazon Seller Central account credentials to complete this step. You cannot
continue with onboarding until you connect your stores.
After integrating your Amazon account, you will be prompted annually to renew your Amazon Sales
Channel connection to Amazon by granting access again.
A list of Pre-Setup Tasks displays with an overview of prerequisites. When ready, tap Begin
Setup.
4. For New Store Name, enter a descriptive name for your new Amazon Sales Channel store.
This name is used as a Magento reference only and will identify the store in the list on the Amazon
Sales Channel Home page. You will want to make it something your team can easily identify. For
example, your Amazon store that sells in the United States region might be named "Amazon Store
USA".
5. From the Amazon Marketplace drop-down, select the region in which for your Amazon store
sells.
6. Tap Save Marketplace. Your new marketplace is saved. Next, connect your new store with your
Amazon Seller Central account.
7. Tap Connect to Amazon Store to launch Amazon Seller Central in a new tab.
8. Enter your Amazon Seller Central account credentials and tap Sign in.
To complete this connection, you must sign in to your Amazon Seller Central account using the log-
in credentials for the primary user (the email or phone used to create the seller account).
9. Complete the Amazon Two-Step Verification by entering the code you receive from Amazon and
tap Sign in.
10. Tap Continue on the Amazon Marketplace Web Service confirmation screen.
You have granted Amazon Sales Channel permission to access and share data with your
Amazon Seller Central account. The Amazon screen closes. A confirmation message displays for
the integration.
If you are managing a store that is in "Active" or "Inactive" status, see Listing Settings.
Listing settings define how your Magento catalog products are listed on Amazon. Your listing
settings consist of several categories that allow you to define the interactions and
communication between Amazon Sales Channel and your respective Amazon Seller Central
account.
When configuring your listing settings, you define your eligibility rules for your Magento
catalog products to automatically published to Amazon as new listings, set up your Amazon
listing prices based on your Magento catalog or on competitor pricing, define your fulfillment
method, and more.
Settings are grouped and available in sections, to expand and configure as needed.
l Third Party Listings: Defines if Amazon Seller Account product listings should be imported
into your Magento catalog.
l Listing Price: Cap Magento pricing attributes and configure pricing settings.
l (B2B) Business Price: Define your tiered-pricing settings when selling to another business.
l Stock / Quantity: Configure your stock management thresholds for inventory management.
l Catalog Search: Configure your search parameters to ensure a reliable process for matching
your Magento catalog products with your Amazon product listings.
l Product Listing Condition: Configure your settings and values for product "condition."
Condition is a product detail that is required by Amazon, but is not required for your
Magento catalog products.
Onboarding steps and sections can be reviewed and modified as much as needed, until you tap
Complete Setup in the Store Review step. Once setup is complete, these settings can be
accessed and modified from the dashboard for the sales channel store.
If you are managing a store that is in "Active" or "Inactive" status, see Product Listing Actions.
The Product Listing Actions section defines how your catalog interacts with Amazon. These
settings include:
l Indicate if your Magento catalog products that meet Amazon eligibility requirements are
automatically sent to your Amazon Seller Central account to create new listings.
l Set the default handling time for an order. This value defines the number of days generally
required for you to process and ship an order. For example, if someone selects 2-day
shipping, that shipping transit time does not start until processing completes and packages
are handed off to a carrier. The total delivery time is (handling time + transit time + any
holidays).
These settings are part of your store's Listing Settings. Update these configurations during
onboarding through the Listing Settings step.
l Automatically List Eligible Products: Select this option if you want your Magento
catalog products (that meet Amazon's eligibility requirements) to automatically push to
Amazon and create new Amazon Listings.
l Do Not Automatically List Eligible Products: Select this option if you want to
manually select your eligible Magento catalog products and create new Amazon
Listings. When selected, catalog products that meet your listing criteria and contain all
required information display on the Ready to List tab for manual publishing. If not
selected, the Ready to List tab does not display.
3. For Default Handling Time (required), enter a numerical amount of lead time days needed
before shipment. The default value is 2 days.
This default handing time value is only effective for Amazon listings created through Amazon Sales
Channel. Any Amazon listings that were created in your Amazon Seller Central account use the
default handling time set for the listing in Amazon.
If you are managing a store that is in "Active" or "Inactive" status, see Third Party Listings.
The Third Party Listings section defines if your Magento catalog will import products from your
existing Amazon Seller Central listings. We recommend importing listings from Amazon, to
ensure all listings have matching Magento products. By having your listings as part of your
When you set to "Import listing", Amazon Sales Channel imports your Amazon listings into
your Magento catalog, attempting to match them to existing products. If a match is not
automatically found, you can import the Amazon listing as a new Magento product or
manually match the listing to a product.
If you select to import listings, select the Magento attributes with values for Amazon Seller SKU
and Amazon ASIN. If you do not have Magento product attributes, consider creating and
assigning them. Mapping these attributes helps correctly match imported Amazon listings to
your Magento products.
The initial listing import initiates when completing your store's setup during onboarding. After
setup is complete and based on your cron settings, Magento continually checks for newly added
Amazon listings (not created in Amazon Sales Channel) and updates your catalog according to
these settings.
These settings are part of your store's Listing Settings. Update these configurations during
onboarding through the Listing Settings step.
2. For Import Third Party Listings (required), select an option in the drop down:
l Import Listing: Select this option if you want products and information from your
Amazon listings to import into your Magento catalog of products. This is the
recommended and the default setting.
l Do Not Import Listing: Select this option if you want to manually create and assign
new products to your Magento catalog for your Amazon listings.
The following options fields are only active when you select to "Import Listing."
3. For Attribute That Contains Amazon Seller SKU, select the Magento attribute that matches to
the Amazon Seller SKU value.
4. For Attribute That Contains Amazon ASIN, select the Magento attribute that you created and
match it to the Amazon ASIN.
If you did not create these Magento attributes for your Amazon listings, see Creating Attributes for
Amazon Matching for information.
If you are managing a store that is in "Active" or "Inactive" status, see Listing Price.
The Listing Price setting defines which Magento pricing attribute to use as your price source,
which is the base (default) price value for your Amazon listings. These defined settings will be
used by your pricing rules to automatically adjust your Amazon listing price relative to the
selected Magento Price Source.
You can configure your pricing scope as global or website. If your pricing scope is set to global,
this means that there is a single price source for all your stores/websites. If your pricing scope
is set to website, the price source will use fallback logic of website price (if available) followed by
the default (global) price.
If your listing rules have more than one website selected in its settings, the order with which
website price is used is determined by the website priority configured in your listing rules. This
allows you to define product pricing across your catalog. To see if you are using website price
scope, see Catalog Price Scope.
The options listed in Magento Price Source, Minimum Advertised Price (Map), and Strike
Through Price (MSRP) include your configured Pricing attributes. Pricing attributes are
Magento product attributes with the Catalog Input Type for Store Owner value set to Price. See
Attribute Input Types.
2. For Magento Price Source (required), select a pricing attribute in the drop-down (default is
"Price").
3. For Minimum Advertised Price (MAP), select a pricing attribute in the drop-down (default is
no selection).
This field enables a minimum advertised price (MAP) for a product. When you define a pricing
attribute and your listing price for a product falls below your determined minimum price
(based on your pricing source and rules), this value becomes the MAP for the listing. This
allows you to implement pricing rules while still controlling your minimum price for a product.
To prevent a listing price from being too low, select a pricing attribute to use as your MAP.
However, if the selected pricing field is not defined for a product, the MAP will not be used.
4. For Strike Through Price (MSRP), select a pricing attribute in the drop down (default is no
selection).
This field determines which pricing attribute is used as the manufacturer's suggested retail
price (MSRP) for a product. If your listing price is less than the defined MSRP, your Amazon
listing will display a strike-through of the MSRP price and display the lower listing price, along
with the calculated “You Save” amount and percentage. However, if the selected pricing field is
not defined for a product, the MSRP feature will not be calculated.
Important: This will only apply to listings that have won the Buy Box position. The Buy Box is
awarded by Amazon to the seller who has the product listed usually at the best price, along with
other factors such as FBA/Prime shipping offered, availability, and the seller’s performance.
5. For Apply Value Added Tax (VAT) field, select an option (default is "Disabled").
l Disabled: Select this option if you do not want to apply VAT to your listing price.
l Enabled: Select this option if you want to apply VAT to your listing price. VAT is
typically used as a sales tax in European countries and is added to your final listed
price within Amazon. VAT does not apply to final price for listings that are used within
an intelligent pricing rule, unless the price floor is hit.
6. For VAT Percentage, enter the value for your VAT rate (default is "0.00").
The value entered in this field will be used to calculate the VAT amount to be added to the
listing price. If 10.2 is entered, a 10.20% VAT will be applied to your listing price. This field is
disabled when the Apply Value Added Tax (VAT) field is set to "Disabled."
The options in this drop-down are dependent on your Magento currency settings. If options are
not available, you may need to set up your currency settings.
If you are managing a store that is in "Active" or "Inactive" status, see (B2B) Business Price.
Amazon Business is a marketplace exclusively open for Amazon registered business accounts,
and only available in the United States, France, Germany, and the United Kingdom in 2019. If
the marketplace allows B2B business pricing, it will be editable within your listing settings.
B2B Business Pricing allows merchants with business accounts to purchase from each other
with the expected performance of the Amazon shopping experience. With B2B business pricing,
businesses can offer tiered pricing based on the quantity purchased.
For your products to be listed on the Amazon Business (B2B) site, you must first enable
business in your Amazon Seller Central account. For more information on the B2B feature, see
Amazon: B2B Central.
These settings are part of your store's Listing Settings. Update these configurations during
onboarding through the Listing Settings step.
l Enabled: Select this option if you want to enable your business to business sales. When
enabled, the business price is set equal to the list price after all pricing rules have been
applied. The business price follows the website pricing scope, if enabled. A business
price can not be less than $1.
l Disabled: Select this option if you want the same listing price for all order quantities.
All Pricing Level fields in this section are disabled when this option is selected.
l Enabled: Select this option if you want to enable pricing that adjusts based on order
quantity. When enabled, the Pricing Level quantity and discount fields enable.
You can define up to five quantity/discount settings that set the tier pricing for your business
listings. In each row, enter the quantity threshold value and the discount percent to apply. For
example, if you enter 5 in the first field of the first row and 5 in the second field, when another
business purchases a quantity of 5 or more, the price will apply a 5% discount.
Onboarding: Stock/Quantity
If you are managing a store that is in "Active" or "Inactive" status, see Stock/Quantity.
The Stock/Quantity settings are used to sync the product quantity details from your Magento
storefront to the quantity on your Amazon Seller Central account. This tool is very powerful
and can be leveraged for additional advertising by displaying urgency to the buyer while
keeping your inventory organized. For example, some merchants may have 150 items of a
particular SKU in stock in their warehouse, and want to make sure that Amazon shoppers can
purchase all of their inventory. Other merchants may wish to only list one item at a time to
create a sense of scarcity to the end user. To do this, you would set the Maximum Listed
Quantity to 1.
Quantity is a regional attribute, and based on the Amazon Marketplace option selected during
store integration. When a change is made to a product's quantity, the change will affect all
Amazon listings that share that Amazon Seller SKU in your Amazon stores that sell in the same
region (as defined during the store's integration). This means that a change to a shared
Amazon Seller SKU in the North America region will not affect your Amazon stores with a
region set for a different region (as defined during the store's integration). Your first Amazon
store that is set up (with the oldest creation date) controls priority in the quantity settings.
These settings are part of your store's Listing Settings. Update these configurations during
onboarding through the Listing Settings step.
For Magento 2.3.x users, Amazon Sales Channel supports the use of the Multi Source Inventory
(MSI) extension without any additional setup. See Managing Inventory.
2. For Out-of-Stock Threshold (required), enter a numerical value for the lowest quantity of a
product in order to keep the product eligible for its Amazon listing (default is "0").
This means that if your Magento product stock goes lower than this number, the respective
Amazon listing will be ineligible for sales through Amazon.
3. For Maximum Listed Quantity (required), enter a numerical value for the quantity you wish to
display in your Amazon listing.
This will list all your eligible Amazon listings at the entered value. As soon as an item is sold,
the Amazon listing will continue to display this quantity. The displayed listing quantity
available will always use this value, even when your actual product quantity is higher or lower.
This setting is typically used when you do not manage product inventory.
4. For "Do Not Manage Stock" Quantity (required), enter a value for your display quantity for
your Amazon listings.
Amazon requires that you publish an available quantity. For Magento products that are set to
not manage stock but you want to list them on Amazon, the listing will be published with
available quantity of the value entered here.
Stock/Quantity
Onboarding: Fulfilled By
Step 2 Options for Listing Settings
If you are managing a store that is in "Active" or "Inactive" status, see Fulfilled By.
"Fulfilled by" settings define who fulfills (or ships) orders. If all of your orders are fulfilled using
one method, select between merchant (you) or Amazon. If you plan on fulfilling orders from
your locations and using Amazon, we recommend using the third option and configuring a
Magento product attribute.
l Fulfilled by Merchant: Select this option when you, the merchant, will fulfill all orders.
When an order is placed, inventory will be deducted from your Magento catalog.
l Fulfilled by Amazon: Select this option if Amazon will fulfill all orders. When selected,
product inventory is not deducted from your Magento catalog when an order is placed.
Inventory stock for Amazon fulfilled orders is stored and deducted from their warehouses.
Before assigning this option, you must verify in your Amazon Seller Central account that
your products are eligible for FBA fulfillment. FBA inventory is directly managed through
The fulfillment method is a regional attribute, and based on the Amazon Marketplace option
selected during store integration. When a change is made, the change will affect all Amazon
listings that share that Amazon Seller SKU in your Amazon stores that sell in the same region
(as defined during the store's integration). This means that a change to a shared Amazon Seller
SKU in the North America region will not affect your Amazon stores with a region set for a
different region (as defined during the store's integration).
These settings are part of your store's Listing Settings. Update these configurations during
onboarding through the Listing Settings step.
2. For the Product Fulfilled By, select who fulfills (ships) the order:
Fulfilled By
Catalog Search settings enable you to set matching search parameters that help to map eligible
Magento products with Amazon listings. Once mapped, Amazon activates actions related to
pricing, quantity, overrides, and order and product synchronization.
Defining these values increases the potential for exact matches, minimizing the need to
manually match product listings later. Adding the attributes as part of your onboarding Pre-
Setup Tasks, Amazon Sales Channel has a higher potential for automatically matching your
products during onboarding and syncs product data between Amazon and Magento after
onboarding.
If you only create the Amazon ASIN attribute (without adding ASIN values per product), your
Magento products may not automatically your Amazon listings will automatically. You can
manually match your products through Store Review. However, manual matching does not
create the data elements needed to share and sync your product data.
Important: If you manually matched a product and you need to update an ASIN, UPC, or other data
element for the product, you would have to update the data in both places, in your Magento catalog
and in your Amazon listing in your Amazon Seller Central account.
If you want to add attributes at this stage of onboarding, see Create Product Attributes for
Amazon Matching.
These settings are part of your store's Listing Settings. Update these configurations during
onboarding through the Listing Settings step.
2. In the ASIN field, select the product attribute you created for the Amazon ASIN value.
3. In the EAN field, select the product attribute you created for the Amazon EAN value.
4. In the GCID field, select the product attribute you created for the Amazon GCIN value.
The Global Catalog Identifier (GCID) is an ID for products that do not have a UPC code or
ISBN. Amazon's Brand Registry allows you to register as a brand owner and create a unique ID
for products.
5. In the ISBN field, select the product attribute you created for the Amazon ISBN value.
The International Standard Book Number (ISBN) is a unique commercial book identifier
barcode. Each ISBN code uniquely identifies a book. ISBN have either 10 or 13 digits. All ISBN
assigned after Jan 1, 2007 have 13 digits.
6. In the UPC field, select the product attribute you created for the Amazon UPC value.
The Universal Product Code (UPC) is a 12-digit bar code used extensively for retail packaging in
United States.
7. In the General Search field, select the product attribute you want to use for a general search
match.
This is an attribute that you can select to match Magento products to the appropriate Amazon
listing. General search uses keyword searches from your catalog. As such, it is recommended to
use a Magento attribute that carries relevant keywords, such as the product SKU or product
name. General search may return many possible matches, and in such cases, you can select the
appropriate Amazon listing from the possible matches. A common selection for this field is
"Product Name."
Catalog Search
If you are managing a store that is in "Active" or "Inactive" status, see Product Listing
Condition.
Amazon requires a product listing to have a defined condition. If all your products are new, you
can select one of the Amazon condition options in the drop down list to represent all of your
products as your global condition value. Standard Amazon conditions include:
l New
l Refurbished
l Used; Good
l Used; Acceptable
l Collectible; Good
l Collectible; Acceptable
However, if your catalog contains products in different conditions (New, Used, Refurbished,
etc.), you must select the Assign Condition Using Product Attribute option. This setting
allows you to map your Magento condition attribute and values to your Amazon listing's
conditions.
During Pre-Setup Tasks, it was recommended that you create a Magento product attribute for a
product's condition. If you offer products in various conditions and you have not created a
condition attribute, see Onboarding: Create a product attribute in Magento. Once the condition
attribute is created, you can assign a condition value to each of your products in your Magento
catalog.
These settings are part of your store's Listing Settings. Update these configurations during
onboarding through the Listing Settings step.
l Assign Condition Using Product Attribute: Select this option if your Magento catalog
contains products in various conditions. When this option is selected, the Condition
Attribute field enables and is required.
3. For Condition Attribute, select the Magento attribute to map values to each Amazon condition
attribute. You may have created the attribute during pre-setup tasks. When selected, a field for
each of the standard Amazon conditions displays. Map Magento attribute values to each
Amazon condition.
l If your products fall into only one condition, you can map to that single Amazon condition,
leaving the others blank.
l If you have products that fall in the Used or Collectible category but you do not distinguish
further, you can map to a single Used or Collectible Amazon category and leave the other
similar options blank. All your Used or Collectible conditions will map to the single Amazon
Used or Collectible category by default.
For example, you have a single Used condition for your products. When mapping, you will
choose whether you want to map to the Amazon condition Used; Like New: Used, Very Good:
Used; Good: or Used; Acceptable. Only complete the field for the Amazon condition option you
want, leaving the other Used options set to"--Select Option--." You'll see in the screen shot
example, all of your Magento products in Used condition map to the Amazon Used; Very Good
condition.
If you are managing a store that is in "Active" or "Inactive" status, see Listing Rules.
Listing Rules define the rules to determine which products Amazon Sales Channel will publish
to your Amazon Marketplace. These rules provide many options to create simple to complex
rules to include or exclude products as listings. Each rule consists of conditions that set the
requirements for product listing eligibility.
Your listing rules are continually synchronized with your Magento catalog. When you add new
Magento products that meet eligibility requirements set by your listing rules, the products will
automatically process for listing on Amazon.
l If you want all of your products to be published to an Amazon listing, do not define any
conditions for your listing rules.
l If you want to limit which of your catalog products that will be published to an Amazon
listing, you will define your listing rule conditions in this step of onboarding. Defining the
conditions for your Amazon listing rules follow the same logic and process as defining the
conditions for Cart Price Rules in Magento.
l If your listing rules exclude a product, the eligibility status for that product changes to
Ineligible. Ineligible products will not be published to Amazon.
l If an ineligible product is already listed on Amazon and you match the Amazon listing to
your Magento catalog product, the quantity for the Amazon listing will change to 0 to
prevent sales of the product. Amazon listings can be manually removed when managing
listings.
Changes to quantity and eligibility status impact all listings that share the Amazon Seller SKU
in marketplaces which exist for stores selling in the same region (as defined in the Amazon
Marketplace field during Store Integration) will also be impacted. However, a change to a
shared Amazon Seller SKU in one region will not affect the product's Amazon listings in a
different region (as defined during Store Integration).
During onboarding, your listing rules will be applied to your catalog products. You can review
ineligible listings on the Ineligible tab in the Store Review step.
3. Define your desired conditions for the eligibility of products to be listed on Amazon.
Important! When you continue to Listing Preview (step 4), the option you selected in the Website
field locks for this integration. To change the website after continuing to step 4, you must exit this
store integration and begin a new one.
Listing Rules
Important! Once you continue to the Listing Preview (step 4), you cannot change the website
selected in your listing rules (step 3) for this integration. To change the website after leaving step 3,
you must exit this store integration and begin a new one.
At this step of onboarding, you have created your listing rules that determine which of your
Magento catalog products are eligible to be listed on Amazon.
Your current Amazon listings are compared against your rules, based on the conditions you
defined. You can then review which products will move to an ineligible status based on your
Listing Preview allows you to preview your potential Amazon listings and make any necessary
adjustments to your listing rules. If you need to adjust your listing rules, click Listing Rules in
the progress bar to return to the listing rules step.
Your potential Amazon listings will populate on the Listing Preview screen in one of three tabs:
l Ineligible Listings: Products listed on this tab are not eligible for Amazon listing based on
your current listing rule settings.
Ineligible products will not be published to Amazon. If an ineligible product is already listed
on Amazon and you match the Amazon listing to your Magento catalog product, the
quantity for the Amazon listing will change to 0 to prevent sales of the product. To
manually remove a listing, see Ending an Amazon Listing.
Products that are not eligible by Amazon requirements are not listed here. Those products
are listed on the Inactive Listings tab.
l Eligible Listings: Products listed on this tab are eligible for Amazon listing based on your
current listing rule setup and are eligible by Amazon requirements. This tab includes your
existing Amazon listings that will import (if you have the Import Third Party Listings field
set to "Import Listing" in the Listing Settings step).
l New Listings: Products listed on this tab include your Magento catalog products that are
newly eligible for Amazon listing based on your current listing rule setup and will create new
Amazon listings.
Listing Preview
Continue to Step 5
If you are managing a store that is in "Active" or "Inactive" status, see Order Settings.
Order Settings define how Amazon orders are imported into and processed in Magento.
Beginning when you integrate Amazon Sales Channel with your Amazon Seller Central account
during onboarding, Amazon orders import and create new orders in Amazon Sales Channel.
Amazon orders are imported and create new orders when the Amazon sets the order status to
"Unshipped." Orders that existed in Amazon in any status other than "Unshipped" prior to
your store's integration will not import.
When an order is created on Amazon, it is not immediately imported into Amazon Sales
Channel. Amazon assigns a "Pending" status to newly created orders. Once Amazon verifies the
order and payment method, Amazon changes the order's status to "Unshipped." This status
change triggers Amazon Sales Channel to import the order and create a corresponding order.
Amazon Sales Channel creates a matching order that corresponds to the Amazon order. Orders
created in Amazon Sales Channel display and can be managed in the Orders tab in Amazon
Sales Channel Home.
l Disabled: Select this option if you do not want to create corresponding orders in
Magento when new orders are received from Amazon. When this option is selected, all
other fields on this screen are disabled.
l Enabled: Select this option if you want to create corresponding Magento orders when
new orders are received from Amazon. Magento orders are created based on Amazon
status and stock levels.
"Enabled" must be selected to manage Amazon orders in Amazon Sales Channel. When
"Disabled" is selected, your Amazon orders will display in the Orders tab but will not have a
corresponding Magento order number and cannot be managed in Amazon Sales Channel.
Information for these orders is for review only. You must manage these orders in your Amazon
Seller Central account.
3. For Import Amazon Orders Into Magento Store (required), select which Magento Store the
Amazon orders will be associated with when they are created in the Magento Order grid. The
list of options in this drop-down is dependent on the Magento stores you have set up in your
configuration. See Stores.
l No Customer Creation (guest): Select this option if you do not want to create a
customer account in Magento using the imported customer data from the Amazon
order. When selected, this option tells Magento to process an imported Amazon order
the same way it processes a guest checkout in Magento.
l Build New Customer Account: Select this option if you want to create a New Customer
Account in Magento using the customer data imported with the Amazon order.
Selecting this option builds your customer database from your Amazon orders.
l Build Using Magento Order Number: Select this option if you want to create a unique
Magento order number for the corresponding Amazon order using the Magento
incrementally-assigned order ID.
l Build Using Amazon Order Number: Select this option if you want to create the
Magento order number using the corresponding Amazon-assigned order number.
Once an order is imported, the Amazon Order Number and the Magento Order Number display in
the Orders tab.
l Reserve Quantity: Select this option when you want the order quantity in the Amazon
order to be "reserved" in your Magento stock quantity. When this option is selected and
you receive an Amazon order, the quantity ordered will "reserve" in your Magento stock
quantity to prevent your Magento stock from "over selling."
Remember, Amazon orders do not import into and create new orders in Magento until Amazon
verifies the order and payment method changes the order status to "Unshipped."
7. For Order Status (required), select an option from the drop-down. Options:
l Default Order Status: Select this option when you want newly created orders imported
from Amazon to be assigned your defined default order status for new orders. The
default status for new orders (unless you have created a custom order status for new
orders) is "Pending." See Processing Orders.
l Custom Order Status: Select this option when you want newly created orders imported
from Amazon to be assigned a status other than the default. When this option is
selected, the Processing Order Status field enables for you to select the status you want
to use for newly created orders imported from Amazon.
l Processing Order Status: Select an option in the drop-down. The options that display
in this field are based on the default status options in Magento. See Order Status. You
can also create a custom order status to display here for selection. To create a custom
order status, see Custom Order Status.
Order Settings
For information on Magento order creation based on Amazon and inventory status, see Order
Settings.
If you are managing a store that is in "Active" or "Inactive" status, see Pricing Rules.
Price rules are initially defined during onboarding, but can be modified at any time after your
store setup is complete. You can access the price rules for a store during setup in the Amazon
Stores tab in Amazon Sales Channel Home. Tap the store's name in the store list to display the
store's onboarding progress. Tap Pricing Rules in the progress bar.
You can add pricing rules for your Amazon listings. Price rules can be used to automatically
adjust your listing prices, based on a set of defined conditions. Price rules are triggered and
calculate your adjusted price before your product is listed on Amazon.
The price source for your Amazon listings is defined in the Magento Price Source field in your
Listing Price settings. Any adjustment calculations defined in the pricing rule use price source as the
starting value.
Amazon Sales Channel gives you the ability to set pricing rules, these pricing rules allow you to
set your Amazon Listing price different than your Price Source. Additionally, you can stack
multiple rules that will work together to adjust your price.
l Pricing Rule General Settings: Defines the name, description, active dates, priority for a rule
and sets the behavior of subsequent rules, based on its priority setting.
l Pricing Rule Conditions: Determine which products will be eligible for the price rule.
l Pricing Rule Actions: Define the adjustment calculations that will be applied to the price
source to determine the listing price.
You can create standard pricing rules that will automatically adjust your Amazon listing price
relative to the selected Magento Price Source. This feature allows you to manipulate your
Amazon prices in a way that is very similar to Magento's Catalog Price Rules. You can create
Another powerful tool is the Intelligent Repricing feature that will adjust your Amazon listing
price based on competitor Buy Box Price or Lowest Competitor Price. Similar to Magento's
Catalog Price Rules, this advanced feature allows you to manipulate your Amazon prices by
creating complex rules that allow you define the scope for a price change for specific products,
products inside of specific categories, or even with specific product attributes.
Using intelligent repricing you can adjust your products listing prices on Amazon, based on
competitor's pricing. Amazon Sales Channel has built in safeguards for you to set to protect
margins or avoid matching the prices of a merchant with low feedback. Using intelligent
repricing rules, Amazon listing prices can be automatically manipulated as a fixed or
percentage amount (up or down) or even synchronized to the Buy Box or Lowest Price on a per
item basis. Rules can even be stacked to provide unlimited flexibility.
Pricing rules determine if your product is listed on Amazon using your defined Price Source or if
the price is automatically adjusted before listing on Amazon, based on defined conditions for
the rule.
You can control important aspects of rules, such as active/inactive status, website eligibility,
optional date ranges, and optional priority levels (used for rule stacking).
For example, you can define and set the conditions for a price rule that, when the conditions
are met, automatically adjust your listing price before it is sent to Amazon.
General Settings Define the name, description, active dates, priority for a rule and
sets the behavior of subsequent rules, based on its priority
setting.
Pricing Rule Conditions Define which of your catalog products are eligible for the pricing rule.
Pricing Rule Actions Define the adjustments applied to the price source to calculate
the listing price.
If you are managing a store that is in "Active" or "Inactive" status, see Price Rule General
Settings.
Define the name, description, active dates, priority for a rule and sets the behavior of
subsequent rules, based on its priority setting.
This is for your internal identification purposes only. The more descriptive the rule name, the better.
This could include information on the products that qualify, the active dates, the formula for
calculating your adjusted price, or any other information you'd find useful if you ever needed to modify
the rule.
l Active: Select this option if you want the pricing rule to apply to your eligible products
and adjust your listing pricing before publishing to Amazon.
l Inactive: Select this option if you do not want the pricing rule to apply to your eligible
products. This option will most likely be used when modifying a pricing rule or turning
it off after a limited promotion.
4. For From and To, enter a beginning and ending date for the pricing rule. You can also tap the
calendar icon to select a date from the dynamic calendar. This automatic start and stop option
is beneficial when setting up limited-time or seasonal promotions with definite begin and end
dates.
5. For Priority, enter a numerical value for the rule's priority. Priority value equal to 1 is the
highest priority. When you have multiple active pricing rules, you can use priority to determine
which rule is applied first. This field is required to use the Discard Subsequent Rules feature.
l Yes: Select this option if you do not want any other pricing rules that may apply to a
product to be applied. Discarding subsequent rules means that, in the event that
multiple pricing rules apply to the same product, only the pricing rule with the highest
defined priority will be applied to a qualifying product. This prevents multiple pricing
rules from stacking and providing unintended additional discounts
To discard subsequent rules, a pricing rule must use priorities which are set in the Priority field.
If you are managing a store that is in "Active" or "Inactive" status, see Price Rule Conditions.
Conditions determine which products will be eligible for the price rule. Defining the conditions
for your Amazon pricing rules follow the same logic and process as defining the conditions for
Cart Price Rules in Magento. If your price rule applies to all products in your Magento catalog,
then leave this section blank
Conditions are based on existing product attribute values. To apply the rule to all products,
leave the conditions section blank.
Condition - Line 1
The condition in this example will define a rule that will apply a 25% discount to all products
that are defined in the "Books" category.
The rule statement has two bold links, which when clicked, display the options for that part of
the statement. If you save the condition without making changing a bold option, the rule
applies to all your products.
You can create different conditions by changing the combination of these values. For this
example, the following condition is used:
1. Click the Add ( ) button at the beginning of the condition line to display available attributes
on which the condition function. Select an attribute on which to base the condition, such as a
conditions combination or a product attribute.
l Conditions Combination: Selecting this option allows you to create an additional set of
"All/Any" and "True/False" conditions inside the existing set.
Conditions Combination
l Product Attribute: The product attributes in this drop down is dependent on the setup of
the attribute. For an attribute to display in the list, it must be configured to be used in
promo rule conditions. See the Use for Promo Rule Conditions field in Product Attributes.
Once you set the attribute, it cannot be changed. To change the attribute, you must delete
the line and add the new attribute. You can delete a condition line by clicking the Delete (
) button at the end of the line.
b. Click the is link, and choose the comparison operator that describes the condition for
products to meet. For this example, the comparison operator is "is." The available options
depend on the attribute selected in the previous step and may include different
comparison options such as matching values, not including or including at least one of a
value, and greater than, equal to, and less than a numerical amount. In this example, the
options are “is” and “is not.”
c. Click the ... “more” link, and choose the attribute value upon which the condition is based.
The options displayed depend on the attribute's setup. You may be asked to select an
option from a drop-down, or you may need to enter text or numerical values for the
condition. For this example, the field displays blank. To select your category(ies) for the
rule, click the chooser icon ( ) to display your selection options. This rule is for Books,
click the Books checkbox. The category number populates in the field. Click the green
checkmark icon ( ) to accept your category selection(s).
This example condition is complete. As stated, this condition means that any product in your
Magento catalog that has a defined category of "Books" (4) is eligible for this pricing rule. You can add
more condition lines to further narrow your eligible products.
2. To add another condition line to the statement, return to step 1 and repeat the process until all
desired conditions are complete.
You can delete a line of the condition statement at any time by clicking the Delete ( ) button
at the end of the line.
When complete with your price conditions, continue to the Pricing Rule Actions section.
If you are managing a store that is in "Active" or "Inactive" status, see Price Rule Actions.
Price Rule Actions define the adjustment calculations that will be applied to the price source to
determine the listing price.
To complete the Price Rule Actions section for a Standard Price Rule:
1. For Rule Type, select "Standard price rule" in the drop-down.
l Decrease By: Select this option if you want the defined price source value to be
decreased before listing to Amazon.
l Increase By: Select this option if you want the defined price source value to be
increased before listing to Amazon.
l Apply as fixed amount: Select this option if you want the defined price source value
adjusted by a fixed amount.
4. For Adjustment Amount (required), enter the numerical value for the price adjustment.
If you selected "Apply as percentage" in the Apply field, enter the percent value (example: 25 for a
25% percent adjustment).
If you selected "Apply as fixed amount" in the Apply field, enter the numerical value for the fixed
amount (example: 25 for a $25 fixed adjustment).
l Use "Buy Box" Price: Select this option when you want to adjust your Amazon pricing
based on the Amazon Buy Box seller price. A Buy Box price exists when multiple sellers
on Amazon offer the same product. Amazon defines the Buy Box seller based on
performance requirements. Merchants seek to win the Buy Box seller status and offers
maximum visibility of your product listings.
l Use Lowest Competitor Price: Select this option when you want to compare and adjust
your listing price to competitor pricing for the same product. When this option is
selected, the Minimum Positive Feedback and Minimum Feedback Count fields
enable.
l Minimum 80/90/95/98% positive feedback: Select this option when you want to limit
the competitors to whom you compare and adjust your pricing for the same product.
This will narrow down your competitors further by requiring their listing to have a
minimum of the chosen percentage of positive feedback and then use the lowest price of
that subset of competitors.
This is an optional numerical value that further narrows down the competitive pricing. For example, if
a merchant has a 95% positive feedback rating, but only has a feedback count of 20, this might not be
a competitor you would want to be included to modify your pricing against. However, if you put a
value of 1000, it would require that the merchant have 95% positive feedback and a minimum of 1000
merchant reviews.
You might use these competitor pricing and feedback options to avoid basing your pricing against a
competitor who has poor feedback and is selling a lower quality product.
l Use all competitor's product conditions: (Default selection) Select this option if you
want your product to compare against any available condition (if a match does not
exist for the condition you are listing).
l Use Only Matching Competitor’s Product Condition: Select this option if you want
your product to compare only against competitor's products in the same condition. If
no match exists, the product will price at the Price Source.
l Apply Variance (if competitor’s product condition differs): Select this option to first
try to compare against your matched product condition. If no matching condition
exists, a variance (as a percentage) will be applied relative to your product condition
and the lowest competitor’s condition.
l Decrease By: Select this option if you want the defined price source value to be
decreased before listing to Amazon.
l Increase By: Select this option if you want the defined price source value to be
increased before listing to Amazon.
l Match Competitor Price: (Intelligent repricing rule only) Select this option if you want
to change your Amazon listing price to match the lowest competitor price, based on
your competitor feedback and variance parameters. When selected, the Apply and
Adjustment Amount fields are removed.
l Apply as fixed amount: Select this option if you want the defined price source value
adjusted by a fixed amount.
3. For Adjustment Amount (required), enter the numerical value for the price adjustment.
If you selected "Apply as percentage" in the Apply field, enter the percent value (example: 25 for a
25% percent adjustment).
If you selected "Apply as fixed amount" in the Apply field, enter the numerical value for the fixed
amount (example: 25 for a $25 fixed adjustment).
See Price Rule Actions.
Select your Magento attribute which will indicate your relative floor limit. For example, if you don’t
want your product listing price to go below the Cost of your item, you would choose the Cost attribute.
l Decrease By: Select this option if you want the defined floor price source value to be
decreased before listing to Amazon.
l Increase By: Select this option if you want the defined floor price source value to be
increased before listing to Amazon.
l Match: Select this option if you want to change your Amazon listing price to match the
lowest competitor price, based on your competitor feedback and variance parameters.
When selected, the Apply and Floor Adjustment Amount fields are disabled.
4. For Floor Adjustment Price, enter the numerical value for the percent to adjust your floor price
source.
In this example, the floor price is set to be 3% above the cost of the item.
Select your optional highest price setting in the Optional Ceiling Price section.
Select your Magento attribute which will indicate your relative ceiling limit. For example, if you don’t
want your product listing price to go above the MSRP of your item, you would choose the
Manufacturer's Suggested Retail Price attribute.
l Decrease By: Select this option if you want the defined ceiling price source value to be
decreased before listing to Amazon.
l Increase By: Select this option if you want the defined ceiling price source value to be
increased before listing to Amazon.
l Match: Select this option if you want to change your Amazon listing price to match the
lowest competitor price, based on your competitor feedback and variance parameters.
When selected, the Apply and Ceiling Adjustment Amount fields are disabled.
4. For Ceiling Adjustment Price, enter the numerical value for the percent to adjust your floor
price source.
In this example, the ceiling price is set to be 2% below the MSRP of the item.
Store Review is the final step of the onboarding process. At this stage of onboarding, Magento
has connected to Amazon, requested your listing information, and compared your Amazon
listings to your listing settings, rules, overrides, and conditions. All listings are categorized
based on these settings.
3. Update listing status by modifying your configurations and listing rules. You have a couple
methods for updating listings:
l Use the actions available on each tab for your listings to review and edit your listings.
You can edit these settings at any time after completing onboarding setup. Access the store
integration through the Amazon Sales Channel Home.
Your Amazon Sales Channel store setup completes, your listing information is published to your
Amazon Seller Central account, and the status of the new store changes " Active" on the Amazon
Sales Channel Home screen.
In this final step, you need to review each of your listings and modify as needed to ensure your
listings are published as you want. Each tab displays based on their status according to your
current settings. If you want to update a listing, match it to your Magento catalog, to change
its publish status, you can use the available actions on each screen as described below.
When your listings display in the status you wish and you are complete with adjusting your
store, listing, and rules settings, you are ready to tap Complete Setup. Your store setup will
complete, your listings and data will transmit and publish to Amazon. After setup, you can
manage your stores, listings, and orders from the Amazon Sales Channel Home screen.
The different tabs on the Store Review screen allow you to review your Amazon listings before
completing your Amazon Sales Channel store setup.
Incomplete Displays your Magento catalog products that meet your defined
listing settings but are missing information required by Amazon
for a listing.
New Third Party Displays your existing Amazon listings (based on information
received from Amazon) that are not matched to a product in your
Magento catalog.
Ready to List Displays your catalog products that are ready to create new
Amazon listings, but your store is not configured to
automatically publish new listings. This tab is used to manually
publish your new listings.
Overrides Displays your Amazon listings that meet the criteria for a defined
override and to which the override has been applied. Overrides
take priority over any other account setting.
Ended Displays your Amazon listings that have manually been ended
(removed) from Amazon.
Each tab differs slightly in the options available in the Actions drop-down, the Select (Action
column) drop-down, and the default and available table columns. The workspace controls are
the same and allow you to customize displayed data.
The Actions drop-down options can apply the selected action to all listings selected (checked),
while options in the Select drop-down in the Action column applies the action only to the
individual listing.
l Re-attempt to auto match to Amazon listings: Selecting this option initiates the automatic
process for matching your Amazon listings data to your Magento catalog. If products are not
automatically matching, revisit your Catalog Search options in your listing lettings. If
listings don't automatically match after updating your Catalog Search options, you can
match products manually in the Update Required Info action.
l Update Required Info: Select this option if listings do not automatically match to your
catalog. You can manually match catalog products to listings, manually assign an ASIN to a
catalog match, or update a missing condition for listing. See Update Required Info.
l View Details: Select this option to view listing details, including the Listing Activity Log,
Buy Box Competitor Pricing, and Lowest Competitor Pricing. This action is for viewing only.
No changes can be made in the listing details. See View Details.
l Create New Catalog Product(s): Select this option to use the information in the Amazon
listing to automatically create a new product in your Magento catalog. This process will
automatically match the Amazon listing to the new catalog product. See Creating and
Assigning Catalog Products.
l Attempt Automatic Match: Select this option to prompt Amazon Sales Channel will
automatically attempt to match the selected listings to your catalog based on your current
Catalog Search options in your Listing Settings. If you modify your Catalog Search options,
this action will allow you to attempt the matching process again.
l Assign Catalog Product: Select this option to manually match the listing with a product in
your Magento catalog. See Creating and Assigning Catalog Products.
l View Details: Select this option to view listing details, including the Listing Activity Log,
Buy Box Competitor Pricing, and Lowest Competitor Pricing. This action is for viewing only.
No changes can be made in the listing details. See View Details.
Ready to List
The Ready to List tab displays your Magento catalog meet your defined listing settings and are
ready to publish to Amazon as a new listing.
The Ready to List tab only displays when your Automatic List Action field in Product Listing
Actions is set to "Do Not Automatically List Eligible Products." This setting tells Amazon Sales
Channel that any new Amazon listings must be published manually. You have a few options to
manually publish a new listing to Amazon:
l Publish Product to Amazon: Select this option to publish the catalog product to a new
listing on Amazon. See Publishing a Ready to List listing.
l Publish On Amazon: Select this option to publish the catalog product to a new listing on
Amazon. See Publishing a Ready to List listing.
Inactive
Listings that display on this tab include your products that have been published to Amazon
but are not active on the Amazon marketplace. Your listings could be inactive for a few different
reasons. For example, you might not be eligible to list that particular brand. Inactive listings
are dictated by Amazon’s listing standards and your Amazon Seller Central account
permissions.
l End Listing(s) on Amazon: Select this option to remove all selected listings from the
Amazon marketplace. See Ended Listings.
l Edit Listing Overrides: Select this option to change the override settings for the listing. See
Overrides.
l Create Override: Select this option to create a new override and apply it to this listing. See
Creating Listing Overrides.
l Edit Assigned ASIN: Select this option to modify the ASIN assigned to your catalog
product. This would be used if a product in your catalog was matched to the wrong ASIN.
See Edit Assigned ASIN.
l Create Alias Seller SKU: Select this option to create an Alias SKU that can be used to create
a new Amazon listing from the same catalog product. See Creating an Alias Seller SKU.
l End Listing: Select this option to remove the listing from the Amazon marketplace. See
Ended Listings.
Active
Listings that display on this tab include your Amazon listings that are active on the Amazon
marketplace and that have been matched to a product in your Magento catalog.
l End Listing(s) on Amazon: Select this option to remove all selected listings from the
Amazon marketplace. See Ended Listings.
l Edit Listing Overrides: Select this option to change the override settings for the listing. See
Overrides.
l View Details: Select this option to view listing details, including the Listing Activity Log,
Buy Box Competitor Pricing, and Lowest Competitor Pricing. This action is for viewing only.
No changes can be made in the listing details. See View Details.
l Create Override: Select this option to create a new override and apply it to this listing. See
Creating Listing Overrides.
l Edit Assigned ASIN: Select this option to modify the ASIN assigned to your catalog
product. This would be used if a product in your catalog was matched to the wrong ASIN.
See Edit Assigned ASIN.
l Create Alias Seller SKU: Select this option to create an Alias SKU that can be used to create
a new Amazon listing from the same catalog product. See Creating an Alias Seller SKU.
l End Listing: Select this option to remove the listing from the Amazon marketplace. See
Ended Listings.
Overrides
Listings that display on this tab include your Amazon listings that meet the criteria for a
defined override and to which the override has been applied. Overrides take priority over any
other account setting.
l Edit Listing Overrides: Select this option to change the override settings for the listing. See
Overrides.
l View Details: Select this option to view listing details, including the Listing Activity Log,
Buy Box Competitor Pricing, and Lowest Competitor Pricing. This action is for viewing only.
No changes can be made in the listing details. See View Details.
l Edit Overrides: Select this option to change the override settings for the listing. See Editing
Overrides.
See Overrides.
Ineligible
Listings that display on this tab include your Amazon listings that are no longer eligible to
publish, based on your defined listing settings.
l End Listing(s) on Amazon: Select this option to remove all selected listings from the
Amazon marketplace. See Ended Listings.
l Edit Listing Overrides: Select this option to change the override settings for the listing. See
Overrides.
l View Details: Select this option to view listing details, including the Listing Activity Log,
Buy Box Competitor Pricing, and Lowest Competitor Pricing. This action is for viewing only.
No changes can be made in the listing details. See View Details.
l Create Override: Select this option to create a new override and apply it to this listing. See
Creating Listing Overrides.
l Create Alias Seller SKU: Select this option to create an Alias SKU that can be used to create
a new Amazon listing from the same catalog product. See Creating an Alias Seller SKU.
l End Listing: Select this option to remove the listing from the Amazon marketplace. See
Ended Listings.
Ended
Listings that display on this tab include your Amazon listings that have manually been
removed from Amazon.
l Publish Product to Amazon: Select this option to republish the listing to the Amazon
marketplace. See Republish an Ended Amazon Listing.
l View Details: Select this option to view listing details, including the Listing Activity Log,
Buy Box Competitor Pricing, and Lowest Competitor Pricing. This action is for viewing only.
No changes can be made in the listing details. See View Details.
l Publish Product to Amazon: Select this option to republish the listing to the Amazon
marketplace. See Republish an Ended Amazon Listing.
l Create Alias Seller SKU: Select this option to create an Alias SKU that can be used to create
a new Amazon listing from the same catalog product. See Creating an Alias Seller SKU.
l Amazon Stores: Review and access your created and linked Amazon stores. Tap on a store
name to review detailed information through the store's dashboard.
l Orders: View and manage orders submitted by customers through your Amazon store and
Amazon Seller Central account. These orders may be reviewed, managed, and shipped
through Magento. Any updates in status, ordered product, payments, cancellations, and
shipments sync between Amazon and Magento.
l Attributes: View and manage linked Magento and Amazon attributes for your product
catalog. Directly edit or create and link attributes directly through Magento to sync
automatically with Amazon.
l Listing Changes Log: Review a log of changes in listings on Amazon by the Seller SKU, with
captured details for the listing action such as updates to pricing and quantities, comments
for the change, and more.
Amazon Sales Channel Home tabs share some common workspace controls that allow you to
customize the data that is displayed.
Amazon Sales Channel Home displays with the Amazon Stores tab displayed by default
Workspace Controls
Amazon Sales Channel Home have some common workspace controls including Filters, Default
View, Columns, and Export. Not all pages will have the same control options.
Actions
The Actions drop-down option displays a list of actions that are available to a user for a screen.
When selected, the action is applied to all selected items. To apply an action to a specific item,
mark the checkbox in the first column of each item and choose an option in the Actions drop-
down.
Filters
The Filters control displays options for narrowing the data displayed in the table. Filter
options are based on the columns selected in the Columns control. Filter options only display
for columns enabled in the Columns control.
Filters controls can include dynamic calendars to narrow data for specified dates, drop-down
menus for columns that have pre-defined selections, and free-text fields that may contain
custom data.
The example below shows the settings for filtering the list of orders to display only orders that
meet the following criteria:
When you have your filtering options set, tap Apply Filters to filter the data listed. Tap Cancel
to exit the Filters control without applying.
View
The View control is based on the default columns for page, thus it is named the Default View.
You can add or remove available columns using the Columns control. When you customize
your columns, you can then save the view as a custom view in the View control.
When you have your columns added or removed from the page display:
You can toggle between the views by selecting the desired view in the View drop-down menu.
If you want to delete or change the name of your custom view, tap the pencil icon. You can
then enter a different name, or you can tap the trash can icon to delete the custom view. The
Default View cannot be deleted.
Columns
The Columns control allows you to add or remove columns of data from the page display. Each
Amazon Sales Channel page has a preset combination of data columns, but most pages have
additional columns available. If no additional columns are available, you can still remove
default columns from display.
The example below shows a Columns control. The checked options correspond to the column
headers that are displayed on the page.
You can tap Reset to set the options back to default settings, or you can tap Cancel to exit
without your changes.
Export
The Export option allows you to export the displayed data to a data file than can be imported
to a third-party software or separate database. Data exported is limited to the data displayed.
You'll want to make sure you add or remove columns if needed prior to using the Export
control.
When ready to export your data, select an export format option and tap Export.
l Excel XML - an XML-based, spreadsheet data format (typically used for Excel users)
The generated data file saves automatically to your designated folder for downloads.
The Amazon Stores tab provides a list of your Amazon stores along with some basic statistics
and management options. Displayed statistics include each store's status, date created, last
updated, available management actions, and defined region. Management options (available in
the Select drop-down in the Actions column) include:
l Manage Store: The action for this option is dependent on the status of the store selected.
If the store is in Active or Inactive status, selecting this option displays the store's dashboard giving
you access to the store's data, revenue and order information, and listing and order settings.
If the store is in Setup status, selecting this option displays the Store Review step for the store's
setup process, where you can review and modify your stores settings, listing and order settings, and
pricing rules before completing setup.
l Change to Active/Inactive: Select this option if you want to change the status of the
store selected. This feature allows you to control order and listing activity at the Amazon
regional level, because each Amazon store has a defined region during setup.
Changing an Inactive store to Active status will activate listings and order activity for the store, using
the stores current setup (listing settings, price rules, overrides, etc.)
Changing an Active store to Inactive status will suspend listings and order activity for the store. An
Inactive store will retain all settings and listings, but will temporarily stop the synchronization of
pricing, quantity, and order management until the store is changed to Active status. This feature
allows you to control your store activity at the Regional level without the need to recreate or
reintegrate your Amazon store or the loss of historical order and sales data.
l Delete Store: Select this option if you wish to delete an existing Amazon store and its
integration settings with your Amazon Seller Central account. Deleting the account will
remove the store from Amazon Sales Channel, along with all account settings, listings, logs
and other information related to this store. The account cannot be retrieved after deletion.
To change the website assigned to the store during integration, you must delete the store and add
the store again with the different website through the onboarding process.
You will notice some workspace controls that are common throughout the Amazon Sales
Channel.
Amazon Stores
Region The region (defined during setup) in which your Amazon store sells.
Example: United States, Canada, United Kingdom.
Created On The date the Amazon store was created in Amazon Sales Channel.
Last Updated The date of the most recent change to the Amazon store's setup.
Actions Lists available actions that can be applied to the store listed. Tap the
Select drop-down and choose an option. Options:
Manage Store
Change To Active/Inactive
Delete Store
Optional Columns
COLUMN DESCRIPTION
Merchant Id This is the code identifier assigned by Magento for the Amazon
Sales Channel store when the store was created and integrated.
The store dashboard is the primary location for you to view the activity for one of your Amazon
stores. With your Amazon Seller stores added and integrated, all orders and sales track through
your store data view. On the dashboard, you can view revenue, track trends, and review sales
data for all listings. All listings and sales are further grouped and tracked by listing type,
including active, inactive, in-progress, incomplete, and orders awaiting shipment.
You can also review and update your store settings, integration settings, listing settings, price
rules, order settings, and more from the store dashboard. On the dashboard, tap one of your
integrated stores. This store dashboard opens for stores in Active and inactive status and
displays data on sales, access for listings, and configuration options for the store.
The store dashboard includes the following sections of data and access to other information:
l Store Data: Displays sales data and links to your listings by status.
l Revenue: Displays a graphical representation for the store's revenue for the last 7 or 30 days.
l Most Recent Orders: Displays the most recent orders that have been received from your
Amazon listings association with the store.
l I Want to See...: Provides links to view and update your various store, listing, rules, and
order settings.
If you select a store with the In Setup status, the Onboarding steps open with populated data saved
for the store integration.
l Inactive Listings
l In Progress Listing
l Incomplete Listings
Revenue A line graph of your sales revenue over a period of time. You can
select to view either the data for last 7 days or the data for the last 30
days. The default view option is "Last 7 Days." You can tap in the
drop-down to change the time period for the graph.
Most Recent Orders A listing of the basic details for the most recent orders that have been
placed in the Amazon store (through your Amazon Seller Central
account). Data includes Purchase Date, Order Number, Status,
Buyer's Name, and purchase Grand Total. Tapping an order number
will display the order details, similar to the Magento Order View.
l Listing Rules
l Pricing Rules
l Store Reports
l Listing Settings
l Order Settings
2. On the store's dashboard, under the I Want To... header, tap Store Integration Settings.
4. For New Store Name, update the descriptive name for your new Amazon Sales Channel store.
This name displays on the Amazon Stores tab.
This name is used as a Magento reference only and will identify the store in the list on the Amazon
Sales Channel Home page. You will want to make it something your team can easily identify. For
example, your Amazon store that sells in the United States region might be named "Amazon Store
USA".
2. Scroll down and tap Sales Channels and then Global Settings. The Sales Channel Settings
screen displays.
l Yes: (Default) Select this option if you want the Revenue section to display on the
store's dashboard. If set to "Yes," the Revenue section displays a graphical
representation for the store's revenue for the last 7 or 30 days.
l No: Select this option if you do not want the Revenue section to display on the store's
dashboard.
l Once Daily: Select this option to clear your store's activity history once daily.
l Once Weekly: Select this option to clear your store's activity history once weekly.
l Once Monthly: (Default) Select this option to clear your store's activity history once
monthly.
Successful communication between Magneto and Amazon requires that Magento attributes be
correctly mapped to the corresponding Amazon attribute. When integrating with Amazon, you
will link (or map) these Magento attributes to Amazon attributes. When complete, Magento can
sync and maintain your Amazon listings with your Magento product catalog.
For example, imagine you have the same item in your Magento catalog and Amazon listings.
One attribute for the product might be the listing price of the item. The name for the listing
price in Magento might be named "Price," while the listing price for Amazon might be named
"ListingPrice." You'll need to tell Magento that when communicating with Amazon, the
Magento attribute named "Price" is the same as the Amazon attribute named "ListingPrice."
This process is called managing attributes, and includes creating new and editing existing
attributes. Making sure that attributes are properly matched will ensure correct communication
between Magento and Amazon.
Once attribute matching is set up, Magento can communicate product information back and
forth with Amazon. If you have Amazon product listings, Magento can import your Amazon
products and details into your Magento catalog, allowing you to manage your Amazon listings
from a single, central catalog of products.
The Amazon Sales Channel allows you to access, review, create, and manage attributes, as
needed. If you add a new attribute to your Magento catalog, you may need to update those
values across all products. For more information on Magento attribute sets and values, see
Product Attributes.
Attribute Options
Access and view all linked attributes through the Attributes tab on the Amazon Sales Channel
Home screen. View this page through the Amazon Sales Channel Home dashboard. Through
this page you can:
Default Columns
COLUMN DESCRIPTION
Region The region for sales activity defined in the Amazon Marketplace
when the Amazon store was set up in the Amazon Sales Channel.
Amazon Attribute Name The name of the attribute defined in the Amazon Seller Central
account.
Product Catalog Attribute The name of the Magento attribute that is matched with the
Code Amazon attribute name. If the attribute is not matched to a
Magento attribute, this field will be blank.
Overwrite Magento Values If set to "Enabled", the Amazon attribute value will overwrite the
corresponding Magento attribute value. This setting only applies
when a Magento attribute exists and is matched with the Amazon
attribute. Options: Disabled / Enabled
Is Active If set to "Enabled", the Amazon and Magento attributes will update
stay in sync.
Actions Links to the Create / Edit Attribute screen for the selected
attribute. If a Magento attribute does not exist, the Create
Attribute link displays. If a Magento attribute is matched to the
Amazon attribute, the Edit Attribute link displays.
Optional Column
COLUMN DESCRIPTION
Id The numerical identifier for the Amazon attribute.
As you create and update attributes, you may want to verify the attribute values for Magento
and Amazon products. These values may differ if you do not sync and import values from
Amazon. To review Amazon values for these attributes, see Reviewing Amazon Attribute Values.
If you want to change those values, continue through the following instructions to create new
attributes or edit existing attribute links between Amazon and Magento.
To create an attribute:
These steps create a new Magento attribute and links it to the selected Amazon attribute.
Depending on configurations, the values may start syncing between catalogs.
1. On the Admin sidebar, tap Marketing. Then under Channels, choose Amazon.
2. Tap Attributes tab. Locate an Amazon attribute and tap Create Attribute.
3. To enable or disable the syncing of the Amazon values to the linked Magento attribute, toggle
Is Active. When activated to "Yes", the values sync according to your configuration.
4. To create a new Magento attribute to link to this Amazon attribute, select "Create New Magento
Attribute" for Select Magento Product Attribute. The attribute will link to the displayed
Amazon Attribute Name.
6. Enter a Magento Product Attribute Code. This value must be all lowercase without spaces.
7. For Attribute Set Ids, select an Magento Attribute Set to assign the attribute to. Attributes tend
to be part of an attribute set, such as a set for colors having attributes for blue, green, yellow,
and red.
8. Select the value Type of the attribute value, such as text, numbers, and so on. The selection
affects the allowed value for the attribute.
9. For Use for Promo Rule Conditions, toggle to allow the Magento attribute to be available for a
parameter within your promotional conditions.
10. For Used in Search, toggle if the attribute and value can be used in product searches.
11. For Comparable on Storefront, toggle if the attribute value can be used in Amazon's "Compare
By" functionality.
After saving, you may want to edit the attribute to review settings and matching Amazon and
Magento values for the attribute. You also have an additional option to indicate if Amazon
values should overwrite Magento values.
Select Magento Product Indicates the selected Magento attribute you want linked to the listed
Attribute Amazon Attribute Name. When creating a new Magento attribute,
select Create New Magento Attribute.
Amazon Attribute Name Displays the name of the Amazon attribute as defined in
Amazon Seller Central. The selected Magento attribute links to
this Amazon attribute. You cannot edit this value through
Magento.
Magento Product Indicates the Magento attribute code, all in lowercase characters
Attribute Code without spaces.
Attribute Set Ids Indicates the Magento Attribute Set to assign the attribute to.
Attributes tend to be part of an attribute set, such as a set for
colors having attributes for blue, green, yellow, and red.
Type Indicates the value type of the attribute value, such as text,
numbers, and so on. The selection affects the allowed value for
the attribute.
Use for Promo Rule Toggle to Yes to allow the Magento attribute to be available for a
Conditions parameter within your promotional conditions.
Used in Search Indicates if the attribute and value can be used in product
searches.
Magento Product Indicates the Magento scope for the Magento attribute.
Attribute Scope
Store Views (to import Select your Magento store view to sync the Amazon attribute
values into to) values to. Selecting All Store Views updates the value across all
Magento store views.
1. On the Admin sidebar, tap Marketing. Then under Channels, choose Amazon.
2. Tap Attributes tab. Locate an Amazon attribute and tap Edit Attribute.
3. To enable or disable the syncing of the Amazon values to the linked Magento attribute, toggle
Is Active. When activated to "Yes", the values sync according to your configuration.
4. Tap the drop-down to Select Magento Product Attribute to link to the displayed Amazon
Attribute Name.
5. Indicate if you want the Amazon synced value to overwrite existing Magento values. For
example, you may not want to overwrite the prices from Amazon into Magento.
l Do Not Overwrite Existing Magento Values: Retains the Magento value, keeping different
values for Magento and Amazon stores.
l Overwrite Existing Magento Values: Saves the Amazon value over the Magento value in the
Magento product catalog.
6. Select one or more Store Views to import Amazon values into. If you select "All Store Views
(Global)", this syncs and saves values to all store views. You may only want to sync values to
specific store views.
Select Magento Product Indicates the selected Magento attribute you want linked to the listed
Attribute Amazon Attribute Name. If you want to change the linked Magento
attribute, select a different attribute from the drop-down list. Values
sync according to configurations.
Amazon Attribute Name Displays the name of the Amazon attribute as defined in
Amazon Seller Central. The selected Magento attribute links to
this Amazon attribute. You cannot edit this value through
Magento.
Overwrite Existing Value Indicates if the Amazon attribute values will overwrite existing
Magento values. This affects all products with this Magento
attribute.
Magento Product Indicates the Magento scope for the Magento attribute.
Attribute Scope
Store Views (to import Select your Magento store view to sync the Amazon attribute
values into to) values to. Selecting All Store Views updates the value across all
Magento store views.
2. Tap the Attributes tab. Locate an Amazon attribute and tap either Create Attribute or Edit
Attribute.
4. To further review Magento product information, tap a linked Magento Product SKU. This opens
the Magento product edit page.
Field Descriptions
FIELD DESCRIPTION
Region The region for sales activity defined in the Amazon Marketplace
when the Amazon store was set up in the Amazon Sales Channel.
Magento Product SKU Indicates the Magento products synced with the Amazon store.
The value is a product ID assigned by Magento and linked to a
product in the catalog. Tap the link to open the product in
Magento.
Amazon Value Indicates the value for the selected attribute. The Amazon Value
differs depending on the attribute type and the Amazon attribute
you view. For example, a listed Amazon value for Label would be
a text value while AmazonListPrice would be a numerical
amount. The status indicates if the Amazon value has been
imported.
Status Indicates if the attribute values have been imported into Magento
and linked to a Magento attribute. Options: Not Imported /
Imported
Listing settings define how your Magento catalog products are listed on Amazon. Your listing
settings consist of several categories that allow you to define the interactions and
communication between Amazon Sales Channel and your respective Amazon Seller Central
account.
When configuring your listing settings, you define your eligibility rules for your Magento
catalog products to automatically published to Amazon as new listings, set up your Amazon
listing prices based on your Magento catalog or on competitor pricing, define your fulfillment
method, and more.
Settings are grouped and available in sections, to expand and configure as needed.
l Third Party Listings: Defines if Amazon Seller Account product listings should be imported
into your Magento catalog.
l Listing Price: Cap Magento pricing attributes and configure pricing settings.
l (B2B) Business Price: Define your tiered-pricing settings when selling to another business.
l Stock / Quantity: Configure your stock management thresholds for inventory management.
l Catalog Search: Configure your search parameters to ensure a reliable process for matching
your Magento catalog products with your Amazon product listings.
l Product Listing Condition: Configure your settings and values for product "condition."
Condition is a product detail that is required by Amazon, but is not required for your
Magento catalog products.
The Product Listing Actions section defines how your catalog interacts with Amazon. These
settings include:
l Indicate if your Magento catalog products that meet Amazon eligibility requirements are
automatically sent to your Amazon Seller Central account to create new listings.
l Set the default handling time for an order. This value defines the number of days generally
required for you to process and ship an order. For example, if someone selects 2-day
shipping, that shipping transit time does not start until processing completes and packages
are handed off to a carrier. The total delivery time is (handling time + transit time + any
holidays).
l Automatically List Eligible Products: Select this option if you want your Magento
catalog products (that meet Amazon's eligibility requirements) to automatically push to
Amazon and create new Amazon Listings.
l Do Not Automatically List Eligible Products: Select this option if you want to
manually select your eligible Magento catalog products and create new Amazon
Listings. When selected, catalog products that meet your listing criteria and contain all
required information display on the Ready to List tab for manual publishing. If not
selected, the Ready to List tab does not display.
3. For Default Handling Time (required), enter a numerical amount of lead time days needed
before shipment. The default value is 2 days.
This default handing time value is only effective for Amazon listings created through Amazon Sales
Channel. Any Amazon listings that were created in your Amazon Seller Central account use the
default handling time set for the listing in Amazon.
Field Descriptions
FIELD DESCRIPTION
Automatic List Action Options:
l Automatically List Eligible Products: (Recommended) Select
this option if you want your Magento catalog products (that
meet Amazon's eligibility requirements) to automatically push
to Amazon and create new Amazon Listings
Default Handling Time The numerical value that represents the number of days, in
general, that it takes you to process and ship your orders. The
default value is 2. This value is used for Amazon listings created
in Magento and published to Amazon. The default handling time
for Amazon listings prior to integrating with Magento are not
affected by this field.
The value defined in Amazon Sales Channel does not replace the
default handling time defined in an existing Amazon listing.
When a Handling Time Override is enabled and then removed,
the Handling Time for an order reverts to the value defined here.
If you have products that have different handling times, you can
create a Handling Time Override at the product-specific level.
You can manage handling time overrides in the Overrides tool,
giving you flexibility to manage your product fulfillment. If there
is no handling time override in Magento for a product, the
handling time default will be the value defined in the Amazon
listing.
The Third Party Listings section defines if your Magento catalog will import products from your
existing Amazon Seller Central listings. We recommend importing listings from Amazon, to
ensure all listings have matching Magento products. By having your listings as part of your
Magento catalog, you can manage all of your products from a single catalog and leverage
Amazon Sales Channel features including fulfillment and order management with Amazon,
intelligent repricing, and quantity management.
When you set to "Import listing", Amazon Sales Channel imports your Amazon listings into
your Magento catalog, attempting to match them to existing products. If a match is not
automatically found, you can import the Amazon listing as a new Magento product or
manually match the listing to a product.
If you select to import listings, select the Magento attributes with values for Amazon Seller SKU
and Amazon ASIN. If you do not have Magento product attributes, consider creating and
assigning them. Mapping these attributes helps correctly match imported Amazon listings to
your Magento products.
The initial listing import initiates when completing your store's setup during onboarding. After
setup is complete and based on your cron settings, Magento continually checks for newly added
Amazon listings (not created in Amazon Sales Channel) and updates your catalog according to
these settings.
2. For Import Third Party Listings (required), select an option in the drop down:
l Import Listing: Select this option if you want products and information from your
Amazon listings to import into your Magento catalog of products. This is the
recommended and the default setting.
l Do Not Import Listing: Select this option if you want to manually create and assign
new products to your Magento catalog for your Amazon listings.
The following options fields are only active when you select to "Import Listing."
3. For Attribute That Contains Amazon Seller SKU, select the Magento attribute that matches to
the Amazon Seller SKU value.
4. For Attribute That Contains Amazon ASIN, select the Magento attribute that you created and
match it to the Amazon ASIN.
Field Descriptions
FIELD DESCRIPTION
Import Third Party Listings Required field. Options:
l Import Listing: (Recommended) Select this option if you want
products and information from your Amazon listings to
import into your Magento catalog of products. This is the
default setting.
The Listing Price setting defines which Magento pricing attribute to use as your price source,
which is the base (default) price value for your Amazon listings. These defined settings will be
used by your pricing rules to automatically adjust your Amazon listing price relative to the
selected Magento Price Source.
You can configure your pricing scope as global or website. If your pricing scope is set to global,
this means that there is a single price source for all your stores/websites. If your pricing scope
is set to website, the price source will use fallback logic of website price (if available) followed by
the default (global) price.
If your listing rules have more than one website selected in its settings, the order with which
website price is used is determined by the website priority configured in your listing rules. This
allows you to define product pricing across your catalog. To see if you are using website price
scope, see Catalog Price Scope.
The options listed in Magento Price Source, Minimum Advertised Price (Map), and Strike
Through Price (MSRP) include your configured Pricing attributes. Pricing attributes are
Magento product attributes with the Catalog Input Type for Store Owner value set to Price. See
Attribute Input Types.
2. For Magento Price Source (required), select a pricing attribute in the drop-down (default is
"Price").
The option selected in this field determines the price source used for your Amazon listings. If
you create pricing rules, the rules are applied to the value defined for the attribute selected
here. You may select any configured pricing attribute, however, if the selected attribute is not
filled in for a product, the price source for the product will default back to "Price" when pricing
rules are applied to determine the published Amazon listing price.
3. For Minimum Advertised Price (MAP), select a pricing attribute in the drop-down (default is
no selection).
This field enables a minimum advertised price (MAP) for a product. When you define a pricing
attribute and your listing price for a product falls below your determined minimum price
(based on your pricing source and rules), this value becomes the MAP for the listing. This
allows you to implement pricing rules while still controlling your minimum price for a product.
To prevent a listing price from being too low, select a pricing attribute to use as your MAP.
However, if the selected pricing field is not defined for a product, the MAP will not be used.
This field determines which pricing attribute is used as the manufacturer's suggested retail
price (MSRP) for a product. If your listing price is less than the defined MSRP, your Amazon
listing will display a strike-through of the MSRP price and display the lower listing price, along
with the calculated “You Save” amount and percentage. However, if the selected pricing field is
not defined for a product, the MSRP feature will not be calculated.
Important: This will only apply to listings that have won the Buy Box position. The Buy Box is
awarded by Amazon to the seller who has the product listed usually at the best price, along with
other factors such as FBA/Prime shipping offered, availability, and the seller’s performance.
5. For Apply Value Added Tax (VAT) field, select an option (default is "Disabled").
l Disabled: Select this option if you do not want to apply VAT to your listing price.
l Enabled: Select this option if you want to apply VAT to your listing price. VAT is
typically used as a sales tax in European countries and is added to your final listed
price within Amazon. VAT does not apply to final price for listings that are used within
an intelligent pricing rule, unless the price floor is hit.
6. For VAT Percentage, enter the value for your VAT rate (default is "0.00").
The value entered in this field will be used to calculate the VAT amount to be added to the
listing price. If 10.2 is entered, a 10.20% VAT will be applied to your listing price. This field is
disabled when the Apply Value Added Tax (VAT) field is set to "Disabled."
The options in this drop-down are dependent on your Magento currency settings. If options are
not available, you may need to set up your currency settings.
Field Descriptions
FIELD DESCRIPTION
Magento Price Source The default option is "Price." The option selected in this field
determines the price source that will be used when creating your
Amazon listings. Should you select another attribute such as
“Amazon Price” or “Special Price," This price will be used on your
Amazon listing. However, should “Amazon Price” or “Special Price”
not be filled out, Price will always be the default value.
Minimum Advertised Price The Magento attribute for MAP pricing. Selecting the MAP option
(MAP) automatically sets your Amazon listing to the MAP price if the listing
price is less than the MAP price.
Strike Through Price The Magento attribute that represents the MSRP pricing. If your
(MSRP) Amazon listing price is less than the MSRP, it will show a strike-
through of the MSRP price and display the listing price.
Strike Through Price (MSRP) also calculates the "You Save" amount
and percentage, but it only applies to listings that have won the Buy
Box position.
You can still view your default Magento and Amazon currencies
when other currencies are available. If your default Magento
currency matches your default Amazon currency, leave Currency
Conversion disabled.
Amazon Business is a marketplace exclusively open for Amazon registered business accounts,
and only available in the United States, France, Germany, and the United Kingdom in 2019. If
the marketplace allows B2B business pricing, it will be editable within your listing settings.
B2B Business Pricing allows merchants with business accounts to purchase from each other
with the expected performance of the Amazon shopping experience. With B2B business pricing,
businesses can offer tiered pricing based on the quantity purchased.
For your products to be listed on the Amazon Business (B2B) site, you must first enable
business in your Amazon Seller Central account. For more information on the B2B feature, see
Amazon: B2B Central.
l Disabled: Select this option if you do not want to enable business to business sales. All
other fields in this section are disabled when this option is selected.
l Enabled: Select this option if you want to enable your business to business sales. When
enabled, the business price is set equal to the list price after all pricing rules have been
applied. The business price follows the website pricing scope, if enabled. A business
price can not be less than $1.
l Disabled: Select this option if you want the same listing price for all order quantities.
All Pricing Level fields in this section are disabled when this option is selected.
l Enabled: Select this option if you want to enable pricing that adjusts based on order
quantity. When enabled, the Pricing Level quantity and discount fields enable.
You can define up to five quantity/discount settings that set the tier pricing for your business
listings. In each row, enter the quantity threshold value and the discount percent to apply. For
example, if you enter 5 in the first field of the first row and 5 in the second field, when another
business purchases a quantity of 5 or more, the price will apply a 5% discount.
Field Descriptions
FIELD DESCRIPTION
Enable Business Pricing Options:
l Disabled: Select this option if you do not want to enable
business to business sales. All other fields in this section are
disabled when this option is selected.
l Disabled: Select this option if you want the same listing price
for all order quantities. All Pricing Level fields in this section
are disabled when this option is selected.
Pricing Level One-Five When Tiered Pricing is enabled, you can define up to five
(qty/discount) quantity/discount settings that set the tier pricing for your business
listings. In each row, enter the quantity threshold value and the
discount percent to apply. For example, if you enter 5 in the first field
of the first row and 5 in the second field, when another business
purchases a quantity of 5 or more, the price will apply a 5% discount.
The Stock/Quantity settings are used to sync the product quantity details from your Magento
storefront to the quantity on your Amazon Seller Central account. This tool is very powerful
and can be leveraged for additional advertising by displaying urgency to the buyer while
keeping your inventory organized. For example, some merchants may have 150 items of a
particular SKU in stock in their warehouse, and want to make sure that Amazon shoppers can
purchase all of their inventory. Other merchants may wish to only list one item at a time to
create a sense of scarcity to the end user. To do this, you would set the Maximum Listed
Quantity to 1.
Quantity is a regional attribute, and based on the Amazon Marketplace option selected during
store integration. When a change is made to a product's quantity, the change will affect all
Amazon listings that share that Amazon Seller SKU in your Amazon stores that sell in the same
region (as defined during the store's integration). This means that a change to a shared
Amazon Seller SKU in the North America region will not affect your Amazon stores with a
region set for a different region (as defined during the store's integration). Your first Amazon
store that is set up (with the oldest creation date) controls priority in the quantity settings.
For Magento 2.3.x users, Amazon Sales Channel supports the use of the Multi Source Inventory
(MSI) extension without any additional setup. See Managing Inventory.
2. For Out-of-Stock Threshold (required), enter a numerical value for the lowest quantity of a
product in order to keep the product eligible for its Amazon listing (default is "0").
This means that if your Magento product stock goes lower than this number, the respective
Amazon listing will be ineligible for sales through Amazon.
3. For Maximum Listed Quantity (required), enter a numerical value for the quantity you wish to
display in your Amazon listing.
This will list all your eligible Amazon listings at the entered value. As soon as an item is sold,
the Amazon listing will continue to display this quantity. The displayed listing quantity
available will always use this value, even when your actual product quantity is higher or lower.
This setting is typically used when you do not manage product inventory.
For example, you may have a product with a quantity of 80 in your Magento catalog. With this
Maximum Listed Quantity set to "10," the Amazon listing will always display a quantity
available of 10 and will refresh each time a sale is made for the product.
Amazon requires that you publish an available quantity. For Magento products that are set to
not manage stock but you want to list them on Amazon, the listing will be published with
available quantity of the value entered here.
Stock/Quantity
Field Descriptions
FIELD DESCRIPTION
Out-of-Stock Threshold Enter a numerical value for the lowest quantity of a product in
order to keep the product eligible for its Amazon listing (default
is "0").
This means that if your Magento product stock goes lower than
this number, the respective Amazon listing will be ineligible for
sales through Amazon.
Maximum Listed Quantity Enter a numerical value for the quantity you wish to display in
your Amazon listing.
This will list all your eligible Amazon listings at the value
denoted. As soon as an item is sold, the Amazon listing will
republish with the quantity entered here. This setting is typically
used when you do not manage product inventory.
"Do Not Manage Stock" Enter a value for your display quantity for your Amazon listings.
Quantity
For example, if we set the Maximum Listed Quantity = 12, but the product has Magento
Quantity = 80, since our Maximum Listed Quantity = 12 this will be how our Amazon product
will display:
If you set your Maximum Listed Quantity to 1, all your eligible products will be listed with a
quantity of 1. As soon as an item is sold, the system will look to your Magento product and re-
list the item if additional stock exists. This option might be chosen if your products are
typically ordered at a quantity of 1. This will also increase urgency for the shopper when
viewing your Amazon listing.
"Fulfilled by" settings define who fulfills (or ships) orders. If all of your orders are fulfilled using
one method, select between merchant (you) or Amazon. If you plan on fulfilling orders from
your locations and using Amazon, we recommend using the third option and configuring a
Magento product attribute.
l Fulfilled by Merchant: Select this option when you, the merchant, will fulfill all orders.
When an order is placed, inventory will be deducted from your Magento catalog.
l Fulfilled by Amazon: Select this option if Amazon will fulfill all orders. When selected,
product inventory is not deducted from your Magento catalog when an order is placed.
Inventory stock for Amazon fulfilled orders is stored and deducted from their warehouses.
Before assigning this option, you must verify in your Amazon Seller Central account that
your products are eligible for FBA fulfillment. FBA inventory is directly managed through
your Amazon Seller Central Account. With this fulfillment method, Amazon Sales Channel
does not share quantity updates between Magento and Amazon. Therefore, not all of the
marketing tools described in the Quantity Settings will be available to you in Amazon Sales
Channel.
The fulfillment method is a regional attribute, and based on the Amazon Marketplace option
selected during store integration. When a change is made, the change will affect all Amazon
listings that share that Amazon Seller SKU in your Amazon stores that sell in the same region
(as defined during the store's integration). This means that a change to a shared Amazon Seller
SKU in the North America region will not affect your Amazon stores with a region set for a
different region (as defined during the store's integration).
2. For the Product Fulfilled By, select who fulfills (ships) the order:
Fulfilled By
Field Descriptions
FIELD DESCRIPTION
Product Fulfilled By Options:
l Fulfilled by Merchant: (FBM) Select this if you fulfill the
orders. When an order is placed, inventory will be deducted
from your Magento catalog. When a new product is created,
the fulfillment method of Merchant Fulfilled will be assigned.
Fulfilled By Attribute Select the Magento attribute used to determine the fulfillment
method.
Options in this list depend on the attributes you set up for your
Amazon products.
Catalog Search settings enable you to set matching search parameters that help to map eligible
Magento products with Amazon listings. Once mapped, Amazon activates actions related to
pricing, quantity, overrides, and order and product synchronization.
Defining these values increases the potential for exact matches, minimizing the need to
manually match product listings later. Adding the attributes as part of your onboarding Pre-
Setup Tasks, Amazon Sales Channel has a higher potential for automatically matching your
products during onboarding and syncs product data between Amazon and Magento after
onboarding.
If you only create the Amazon ASIN attribute (without adding ASIN values per product), your
Magento products may not automatically your Amazon listings will automatically. You can
manually match your products through Store Review. However, manual matching does not
create the data elements needed to share and sync your product data.
Important: If you manually matched a product and you need to update an ASIN, UPC, or other data
element for the product, you would have to update the data in both places, in your Magento catalog
and in your Amazon listing in your Amazon Seller Central account.
2. In the ASIN field, select the product attribute you created for the Amazon ASIN value.
3. In the EAN field, select the product attribute you created for the Amazon EAN value.
The Global Catalog Identifier (GCID) is an ID for products that do not have a UPC code or
ISBN. Amazon's Brand Registry allows you to register as a brand owner and create a unique ID
for products.
5. In the ISBN field, select the product attribute you created for the Amazon ISBN value.
The International Standard Book Number (ISBN) is a unique commercial book identifier
barcode. Each ISBN code uniquely identifies a book. ISBN have either 10 or 13 digits. All ISBN
assigned after Jan 1, 2007 have 13 digits.
6. In the UPC field, select the product attribute you created for the Amazon UPC value.
The Universal Product Code (UPC) is a 12-digit bar code used extensively for retail packaging in
United States.
7. In the General Search field, select the product attribute you want to use for a general search
match.
This is an attribute that you can select to match Magento products to the appropriate Amazon
listing. General search uses keyword searches from your catalog. As such, it is recommended to
use a Magento attribute that carries relevant keywords, such as the product SKU or product
name. General search may return many possible matches, and in such cases, you can select the
appropriate Amazon listing from the possible matches. A common selection for this field is
"Product Name."
Catalog Search
Field Descriptions
FIELD DESCRIPTION
ASIN A unique block of 10 letters and/or numbers that identify items.
EAN (European Article A 12- or 13-digit product identification code. The European Article
Number) Number (EAN) is a barcode standard, a 12 or 13-digit product
identification code. Each EAN uniquely identifies the product,
manufacturer, and its attributes; typically, the EAN is printed on a
product label or packaging as a bar code. Amazon requires EAN
codes to improve quality of search results and the quality of the
catalog. You can obtain EANs from the manufacturer.
GCID (Global Catalog The Global Catalog Identifier (GCID) is an ID for products that do not
Identifier) have a UPC code or ISBN. Amazon's Brand Registry allows you to
register as a brand owner and create a unique ID for products that
may not have a UPC or ISBN.
ISBN (International A 10- or 13-digit unique commercial book identifier barcode. The
Standard Book Number) International Standard Book Number (ISBN) is a unique commercial
book identifier barcode. Each ISBN code uniquely identifies a book.
ISBN have either 10 or 13 digits. All ISBN assigned after Jan 1, 2007
have 13 digits.
UPC (Universal Product A 12-digit bar code. The Universal Product Code (UPC) is a 12-digit
Code) bar code used extensively for retail packaging in United States.
General Search Select an attribute from the drop-down. This is an attribute that
you can select to match Magento products to the appropriate
Amazon listing. General search uses keyword searches from your
catalog. As such, it is recommended to use a Magento attribute
that carries relevant keywords, such as the product SKU or
product name. General search may return many possible
matches, and in such cases, you can select the appropriate
Amazon listing from the possible matches. A common selection
for this field is "Product Name."
Amazon requires a product listing to have a defined condition. If all your products are new, you
can select one of the Amazon condition options in the drop down list to represent all of your
products as your global condition value. Standard Amazon conditions include:
l New
l Refurbished
l Used; Good
l Used; Acceptable
l Collectible; Good
l Collectible; Acceptable
However, if your catalog contains products in different conditions (New, Used, Refurbished,
etc.), you must select the Assign Condition Using Product Attribute option. This setting
allows you to map your Magento condition attribute and values to your Amazon listing's
conditions.
During Pre-Setup Tasks, it was recommended that you create a Magento product attribute for a
product's condition. If you offer products in various conditions and you have not created a
condition attribute, see Onboarding: Create a product attribute in Magento. Once the condition
attribute is created, you can assign a condition value to each of your products in your Magento
catalog.
l Assign Condition Using Product Attribute: Select this option if your Magento catalog
contains products in various conditions. When this option is selected, the Condition
Attribute field enables and is required.
3. For Condition Attribute, select the Magento attribute to map values to each Amazon condition
attribute. You may have created the attribute during pre-setup tasks. When selected, a field for
each of the standard Amazon conditions displays. Map Magento attribute values to each
Amazon condition.
l If your products fall into only one condition, you can map to that single Amazon condition,
leaving the others blank.
l If you have products that fall in the Used or Collectible category but you do not distinguish
further, you can map to a single Used or Collectible Amazon category and leave the other
similar options blank. All your Used or Collectible conditions will map to the single Amazon
Used or Collectible category by default.
For example, you have a single Used condition for your products. When mapping, you will
choose whether you want to map to the Amazon condition Used; Like New: Used, Very Good:
Used; Good: or Used; Acceptable. Only complete the field for the Amazon condition option you
want, leaving the other Used options set to"--Select Option--." You'll see in the screen shot
example, all of your Magento products in Used condition map to the Amazon Used; Very Good
condition.
Condition Attribute The attribute that defines the condition for your products. Select
the product attribute you created for the Amazon condition
attribute. In our Pre-Setup Tasks example, we recommended
naming it "Amazon Condition." When selected, a field for each of
the standard Amazon conditions displays for mapping to the
condition values you added when you created your condition
attribute.
Defined Seller Condition Additional information about the condition of the product. There is a
Fields 1,000-character limit. Seller notes are not allowed for products that
Notes are listed in New condition.
For each of the standard Amazon conditions, select the
corresponding option to map in the drop-down. The options in
the drop-down are the condition labels you added when you
created your Amazon condition attribute.
Listing rules are initially defined during onboarding, but can be modified at any time after your
store setup is complete. You can access the listing rules for an Active or Inactive store in the
store's dashboard. In the I Want To... section, tap Listing Rules.
Listing Rules define the rules to determine which products Amazon Sales Channel will publish
to your Amazon Marketplace. These rules provide many options to create simple to complex
rules to include or exclude products as listings. Each rule consists of conditions that set the
requirements for product listing eligibility.
Your listing rules are continually synchronized with your Magento catalog. When you add new
Magento products that meet eligibility requirements set by your listing rules, the products will
automatically process for listing on Amazon.
l If you want all of your products to be published to an Amazon listing, do not define any
conditions for your listing rules.
l If you want to limit which of your catalog products that will be published to an Amazon
listing, you will define your listing rule conditions in this step of onboarding. Defining the
conditions for your Amazon listing rules follow the same logic and process as defining the
conditions for Cart Price Rules in Magento.
l If your listing rules exclude a product, the eligibility status for that product changes to
Ineligible. Ineligible products will not be published to Amazon.
l If an ineligible product is already listed on Amazon and you match the Amazon listing to
your Magento catalog product, the quantity for the Amazon listing will change to 0 to
prevent sales of the product. Amazon listings can be manually removed when managing
listings.
Changes to quantity and eligibility status impact all listings that share the Amazon Seller SKU
in marketplaces which exist for stores selling in the same region (as defined in the Amazon
Marketplace field during Store Integration) will also be impacted. However, a change to a
shared Amazon Seller SKU in one region will not affect the product's Amazon listings in a
different region (as defined during Store Integration).
3. Define your desired conditions for the eligibility of products to be listed on Amazon.
Listing Rules
Field Descriptions
FIELD DESCRIPTION
Websites The options in this drop-down are dependent on the websites you
have set up in your Magento configuration. Select the website to
represent which website to have eligible products listed on Amazon.
Only one website can be selected, as each website requires a unique
Amazon store created in Amazon Sales Channel.
Conditions Used to define the Magento attributes for product eligibility within
your Amazon region. See Example: Define a Condition.
Conditions Workspace
Any areas in the conditions that are bold can be taped to see the various options.
l Don’t add conditions if all products within the selected website(s) are eligible.
When you are modifying your condition definitions for your listing rules for an Active store,
you can tap Preview Changes to apply your rules changes and view how your listings are
impacted. It is recommended to verify your listings in this listing preview feature before saving
your changes to your listing rules.
Your current Amazon listings are compared against your rules, based on the conditions you
defined. You can then review which products will move to an ineligible status based on your
current Amazon Seller Central account, which products will move from an ineligible state back
to an eligible state, and which products will be New Amazon Listings and added to your
Amazon listing from your eligible Magento catalog.
Listing Preview allows you to preview your potential Amazon listings and make any necessary
adjustments to your listing rules. If you need to adjust your listing rules, click Listing Rules in
the progress bar to return to the listing rules step.
Your potential Amazon listings will populate on the Listing Preview screen in one of three tabs:
l Ineligible Listings: Products listed on this tab are not eligible for Amazon listing based on
your current listing rule settings.
Ineligible products will not be published to Amazon. If an ineligible product is already listed
on Amazon and you match the Amazon listing to your Magento catalog product, the
quantity for the Amazon listing will change to 0 to prevent sales of the product. To
manually remove a listing, see Ending an Amazon Listing.
Products that are not eligible by Amazon requirements are not listed here. Those products
are listed on the Inactive Listings tab.
l Eligible Listings: Products listed on this tab are eligible for Amazon listing based on your
current listing rule setup and are eligible by Amazon requirements. This tab includes your
existing Amazon listings that will import (if you have the Import Third Party Listings field
set to "Import Listing" in the Listing Settings step).
l New Listings: Products listed on this tab include your Magento catalog products that are
newly eligible for Amazon listing based on your current listing rule setup and will create new
Amazon listings.
5. If your listings match your expectations, tap Save Listing Rules. If your listings do no not
display as expected, tap Back and continue to modify your conditions until your listings
match your expectations.
Listing Preview
Field Descriptions
FIELD DESCRIPTION
Product ID The unique, sequential number that is assigned to a Magento
catalog product when it is added.
Attribute Set The name of the attribute set used as a template for the product,
managed in the Magento Products Grid.
SKU The unique Stock Keeping Unit that is assigned to the product,
managed in the Magento Products Grid.
l Catalog
l Search
l Catalog, Search
l Enabled
l Disabled
This feature allows you to manipulate your Amazon prices in a way that is very similar to
Magento's Catalog Price Rules. You can create complex rules that allow you to change prices for
specific products, products inside of specific categories, or even with specific attributes.
You can add pricing rules for your Amazon listings. Price rules can be used to automatically
adjust your listing prices, based on a set of defined conditions. Price rules are triggered and
calculate your adjusted price before your product is listed on Amazon.
The price source for your Amazon listings is defined in the Magento Price Source field in your
Listing Price settings. Any adjustment calculations defined in the pricing rule use price source as the
starting value.
Amazon Sales Channel gives you the ability to set pricing rules, these pricing rules allow you to
set your Amazon Listing price different than your Price Source. Additionally, you can stack
multiple rules that will work together to adjust your price.
l Pricing Rule General Settings: Defines the name, description, active dates, priority for a rule
and sets the behavior of subsequent rules, based on its priority setting.
l Pricing Rule Conditions: Determine which products will be eligible for the price rule.
l Pricing Rule Actions: Define the adjustment calculations that will be applied to the price
source to determine the listing price.
You can create standard pricing rules that will automatically adjust your Amazon listing price
relative to the selected Magento Price Source. This feature allows you to manipulate your
Amazon prices in a way that is very similar to Magento's Catalog Price Rules. You can create
complex rules that automatically change prices for specific products, products inside of specific
categories, or products with specific attributes. You can complete traditional settings and
reprice your products to increase or decrease based on a fixed amount or a percentage.
Using intelligent repricing you can adjust your products listing prices on Amazon, based on
competitor's pricing. Amazon Sales Channel has built in safeguards for you to set to protect
margins or avoid matching the prices of a merchant with low feedback. Using intelligent
repricing rules, Amazon listing prices can be automatically manipulated as a fixed or
percentage amount (up or down) or even synchronized to the Buy Box or Lowest Price on a per
item basis. Rules can even be stacked to provide unlimited flexibility.
Pricing rules determine if your product is listed on Amazon using your defined Price Source or if
the price is automatically adjusted before listing on Amazon, based on defined conditions for
the rule.
You can control important aspects of rules, such as active/inactive status, website eligibility,
optional date ranges, and optional priority levels (used for rule stacking).
For example, you can define and set the conditions for a price rule that, when the conditions
are met, automatically adjust your listing price before it is sent to Amazon.
Another pricing option is a price override, which is set at the individual listing level. A price
override can be set, and an override ignores/takes priority over all other defaults, settings, and
rules. An override can be set for price, handling time, condition, and seller notes (with a few
exceptions). See Overrides.
Pricing Rules
Default Columns
COLUMN DESCRIPTION
Name The name of the pricing rule, as set in Pricing Rule General
Settings.
Rule Type The rule type, as set in Pricing Rule Actions (either Standard
price rule or Intelligent repricing rule).
Priority The priority over other pricing conditions, as set in Pricing Rule
General Settings.
Stop Further Rules Whether any further price rules will be processed on products
Processing eligible for this rule, as set in Pricing Rule General Settings.
From Date The beginning of the time period in which the rule is active.
To Date The end of the time period in which the rule is active.
Action Lists all actions that can be applied to a specific listing. To apply an
action, in the Action column, tap the Select drop-down. Options:
Edit Price Rule
Delete Price Rule
A standard price rule action allows you to increase or decrease an Amazon listing price by a
specific percentage or fixed dollar amount relative to the Magento catalog price (or price
source).
An intelligent repricing rule uses Amazon competitors' pricing to determine your listing price.
Competitors are other sellers that are listing the same products you are listing on Amazon.
2. Price Adjustment
3. Floor Price
Define the name, description, active dates, priority for a rule and sets the behavior of
subsequent rules, based on its priority setting.
This is for your internal identification purposes only. The more descriptive the rule name, the better.
This could include information on the products that qualify, the active dates, the formula for
calculating your adjusted price, or any other information you'd find useful if you ever needed to modify
the rule.
l Active: Select this option if you want the pricing rule to apply to your eligible products
and adjust your listing pricing before publishing to Amazon.
l Inactive: Select this option if you do not want the pricing rule to apply to your eligible
products. This option will most likely be used when modifying a pricing rule or turning
it off after a limited promotion.
4. For From and To, enter a beginning and ending date for the pricing rule. You can also tap the
calendar icon to select a date from the dynamic calendar. This automatic start and stop option
is beneficial when setting up limited-time or seasonal promotions with definite begin and end
dates.
5. For Priority, enter a numerical value for the rule's priority. Priority value equal to 1 is the
highest priority. When you have multiple active pricing rules, you can use priority to determine
which rule is applied first. This field is required to use the Discard Subsequent Rules feature.
l Yes: Select this option if you do not want any other pricing rules that may apply to a
product to be applied. Discarding subsequent rules means that, in the event that
multiple pricing rules apply to the same product, only the pricing rule with the highest
defined priority will be applied to a qualifying product. This prevents multiple pricing
rules from stacking and providing unintended additional discounts
l No: Select this option if you want to allow multiple pricing rules to apply to the same
product. This could result in stacking and providing multiple discounts applied to your
listing price.
Field Descriptions
FIELD DESCRIPTION
Rule Name Enter a name for the rule, used for internal identification purposes.
The more descriptive the rule name, the better (for example, "25% off
end of year book sale.")
Description Enter a detailed description to explain the rule (also used for internal
purposes). For example, "End of year sale, 25% off all items in the
Books Category."
Status Options:
l Inactive - The pricing rule will not apply to your eligible
products. This option will most likely be used when modifying
a pricing rule or turning it off after a limited promotion.
From Optional. Enter the start date when the pricing rule will begin.
For example, if you want to have a sale during the last month of
the year, you would select December 1st so that the pricing rule
would automatically apply to your Amazon listings starting
December 1st.
To Optional. Enter the end date when the pricing rule ends.
Continuing the previous example, since we only want our sale
during the last month of the year, you would set the To date as
December 31st, so the pricing rule will expire on December 31st.
Discard Subsequent The ability to discard subsequent rules is a great feature inside of
Rules pricing rules that prevents multiple pricing rules from stacking
and providing unintended additional discounts. To discard
subsequent rules, a pricing rule must have a priority value
defined in the Priority field. Options:
l Yes: Select this option if you do not want any other pricing
rules that may apply to a product to be applied. Discarding
subsequent rules means that, in the event that multiple
pricing rules apply to the same product, only the pricing rule
with the highest defined priority will be applied to a
qualifying product. This prevents multiple pricing rules from
stacking and providing unintended additional discounts
Conditions determine which products will be eligible for the price rule. Defining the conditions
for your Amazon pricing rules follow the same logic and process as defining the conditions for
Cart Price Rules in Magento. If your price rule applies to all products in your Magento catalog,
then leave this section blank.
Any areas in the conditions that are bold can be taped to see the various options.
Conditions are based on existing product attribute values. To apply the rule to all products,
leave the conditions section blank.
If you want to define a condition based on a specific product attribute, the Use for Promo Rule
Conditions field for the attribute must be set to "Yes." The field is located on the Storefront
Properties screen for the attribute.
Condition - Line 1
The condition in this example will define a rule that will apply a 25% discount to all products
that are defined in the "Books" category.
The rule statement has two bold links, which when clicked, display the options for that part of
the statement. If you save the condition without making changing a bold option, the rule
applies to all your products.
You can create different conditions by changing the combination of these values. For this
example, the following condition is used:
l Conditions Combination: Selecting this option allows you to create an additional set of
"All/Any" and "True/False" conditions inside the existing set.
Conditions Combination
l Product Attribute: The product attributes in this drop down is dependent on the setup of
the attribute. For an attribute to display in the list, it must be configured to be used in
promo rule conditions. See the Use for Promo Rule Conditions field in Product Attributes.
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 selected condition is "Category.”
Once you set the attribute, it cannot be changed. To change the attribute, you must delete
the line and add the new attribute. You can delete a condition line by clicking the Delete (
) button at the end of the line.
b. Click the is link, and choose the comparison operator that describes the condition for
products to meet. For this example, the comparison operator is "is." The available options
depend on the attribute selected in the previous step and may include different
comparison options such as matching values, not including or including at least one of a
value, and greater than, equal to, and less than a numerical amount. In this example, the
options are “is” and “is not.”
This example condition is complete. As stated, this condition means that any product in your
Magento catalog that has a defined category of "Books" (4) is eligible for this pricing rule. You can add
more condition lines to further narrow your eligible products.
2. To add another condition line to the statement, return to step 1 and repeat the process until all
desired conditions are complete.
You can delete a line of the condition statement at any time by clicking the Delete ( ) button
at the end of the line.
Price Rule Actions define the adjustment calculations that will be applied to the price source to
determine the listing price.
A standard price rule allows you to increase or decrease an Amazon listing price by a specific
percentage or fixed dollar amount relative to the Magento catalog price (or price source).
Select Rule Type Set the rule type, "Standard price rule."
Price Adjustment Define the adjustment calculations that will be applied to the
price source to determine the listing price
An intelligent repricing rule uses Amazon competitors' pricing to determine your listing price.
Competitors are other sellers that are listing the same products you are listing on Amazon.
Select Rule Type Set the rule type, "Intelligent repricing rule," along with
competitor price source and feedback requirements.
Competitor Conditional Define variances for conditions of the same product sold by
Variances competitors.
Price Adjustment Define the adjustment calculations that will be applied to the
price source to determine the listing price
Floor Price Define your lowest price for a product to prevent multiple pricing
rules from setting a listing price too low.
Optional Ceiling Price Define your highest price for a product to ensure that your
pricing remains competitive.
l Price Adjustment
To complete the Price Rule Actions section for a Standard Price Rule:
1. For Rule Type, select "Standard price rule" in the drop-down.
l Decrease By: Select this option if you want the defined price source value to be
decreased before listing to Amazon.
l Increase By: Select this option if you want the defined price source value to be
increased before listing to Amazon.
l Apply as percentage: Select this option if you want the defined price source value
adjusted by a percentage.
l Apply as fixed amount: Select this option if you want the defined price source value
adjusted by a fixed amount.
4. For Adjustment Amount (required), enter the numerical value for the price adjustment.
If you selected "Apply as percentage" in the Apply field, enter the percent value (example: 25 for a
25% percent adjustment).
If you selected "Apply as fixed amount" in the Apply field, enter the numerical value for the fixed
amount (example: 25 for a $25 fixed adjustment).
Field Descriptions
FIELD DESCRIPTION
Rule Type Select "Standard price rule."
l Increase By: Select this option if you want the defined price
source value to be increased before listing to Amazon.
Apply Options:
l Apply as percentage: Select this option if you want the
defined price source value adjusted by a percentage.
l Price Adjustment
l Floor Price
l Use "Buy Box" Price: Select this option when you want to adjust your Amazon pricing
based on the Amazon Buy Box seller price. A Buy Box price exists when multiple sellers
on Amazon offer the same product. Amazon defines the Buy Box seller based on
performance requirements. Merchants seek to win the Buy Box seller status and offers
maximum visibility of your product listings.
l Use Lowest Competitor Price: Select this option when you want to compare and adjust
your listing price to competitor pricing for the same product. When this option is
selected, the Minimum Positive Feedback and Minimum Feedback Count fields
enable.
l All Competitor's Prices: Select this option when you want to compare and adjust your
pricing based on all competitor prices for the same product.
l Minimum 80/90/95/98% positive feedback: Select this option when you want to limit
the competitors to whom you compare and adjust your pricing for the same product.
This will narrow down your competitors further by requiring their listing to have a
minimum of the chosen percentage of positive feedback and then use the lowest price of
that subset of competitors.
You might use these competitor pricing and feedback options to avoid basing your pricing against a
competitor who has poor feedback and is selling a lower quality product.
Field Descriptions
FIELD DESCRIPTION
Rule Type Options:
l Use "Buy Box" Price: Select this option when you want to
adjust your Amazon pricing based on the Amazon Buy Box
seller price. A Buy Box price exists when multiple sellers on
Amazon offer the same product. Amazon defines the Buy Box
seller based on performance requirements. Merchants seek to
win the Buy Box seller status and offers maximum visibility of
your product listings.
Minimum Positive Only active if Use Lowest Competitor Price is selected. Options:
Feedback
l All Competitor's Prices: Select this option when you want to
compare and adjust your pricing based on all competitor prices
for the same product.
Minimum Feedback Only active if Use Lowest Competitor Price is selected. This is an
Count optional numerical value that further narrows down the
competitive pricing. For example, if a merchant has a 95% positive
feedback rating, but only has a feedback count of 20, this might
not be a competitor you would want to be included to modify your
pricing against. However, if you put a value of 1000, it would
require that the merchant have 95% positive feedback and a
minimum of 1000 merchant reviews.
l Price Adjustment
l Floor Price
An intelligent repricing rule uses Amazon competitors' pricing to determine your listing price.
Competitors are other sellers that are listing the same products you are listing on Amazon.
If a product exists with the same condition as yours, the base match price will be the lowest
competitor price with the same condition. If no competitors match your condition, the base
match price will then go through other available competitor conditions starting with New,
Refurbished, and continuing down through available conditions. After a condition is found, the
base match price will be the lowest price within that condition.
For example, if you have a product listed with the condition Used; Good, and the base match
price is $7.99, and a competitor exists with the same product in the same condition (Used;
Good) at a lower price, that price is used. If a competitor does not exist with the same
condition, the system checks for a competitor with the next condition, which is New. If a
competitor is found with that condition, the lowest of the prices is used.
l Use all competitor's product conditions: (Default selection) Select this option if you
want your product to compare against any available condition (if a match does not
exist for the condition you are listing).
l Use Only Matching Competitor’s Product Condition: Select this option if you want
your product to compare only against competitor's products in the same condition. If
no match exists, the product will price at the Price Source.
l Apply Variance (if competitor’s product condition differs): Select this option to first
try to compare against your matched product condition. If no matching condition
exists, a variance (as a percentage) will be applied relative to your product condition
and the lowest competitor’s condition.
Field Descriptions
FIELD DESCRIPTION
Competitor Conditional Use all competitor’s product conditions - If a match does not
Variances exist for the condition you are listing your product with, this
option will match against any available condition. It will first
attempt to match your condition, and will then work its way
down from the New condition to Used; Acceptable.
l Merchant Condition Variance (MCV) = The variance for the condition of our product. In our
example, MCV = the variance for condition Used; Good.
Example:
The conditional variance settings are as follows:
l BMP = $7.99 (Base match price = The lowest price of the matched competitor condition)
Using the conditional variance base calculation from above, our conditional variance base =
$6.39. This will be the competitor price source used for our price rule actions, explained further
in Price Adjustment.
l Floor Price
The price adjustment determines what you do once you have identified the competitor price
source.
l Decrease By: Select this option if you want the defined price source value to be
decreased before listing to Amazon.
l Increase By: Select this option if you want the defined price source value to be
increased before listing to Amazon.
l Match Competitor Price: (Intelligent repricing rule only) Select this option if you want
to change your Amazon listing price to match the lowest competitor price, based on
your competitor feedback and variance parameters. When selected, the Apply and
Adjustment Amount fields are removed.
l Apply as percentage: Select this option if you want the defined price source value
adjusted by a percentage.
l Apply as fixed amount: Select this option if you want the defined price source value
adjusted by a fixed amount.
3. For Adjustment Amount (required), enter the numerical value for the price adjustment.
If you selected "Apply as percentage" in the Apply field, enter the percent value (example: 25 for a
25% percent adjustment).
If you selected "Apply as fixed amount" in the Apply field, enter the numerical value for the fixed
amount (example: 25 for a $25 fixed adjustment).
Field Descriptions
FIELD DESCRIPTION
Price Action Options:
l Decrease By: Select this option if you want the defined price
source value to be decreased before listing to Amazon.
l Increase By: Select this option if you want the defined price
source value to be increased before listing to Amazon.
Apply Options:
l Apply as percentage: Select this option if you want the
defined price source value adjusted by a percentage.
l Price Adjustment
l Floor Price
The automated limit settings are used to help protect the floor pricing against the intelligent
pricing rules. This allows the store owner to set a floor for their intelligent pricing rules with the
ease of mind that the automated rules will not price their Amazon listing below a desired price.
Floor price attributes will work off the website scope if your Magento store is using website
pricing scope. For more information, see Price Scope.
Select your Magento attribute which will indicate your relative floor limit. For example, if you don’t
want your product listing price to go below the Cost of your item, you would choose the Cost attribute.
l Decrease By: Select this option if you want the defined floor price source value to be
decreased before listing to Amazon.
l Increase By: Select this option if you want the defined floor price source value to be
increased before listing to Amazon.
l Match: Select this option if you want to change your Amazon listing price to match the
lowest competitor price, based on your competitor feedback and variance parameters.
When selected, the Apply and Floor Adjustment Amount fields are disabled.
4. For Floor Adjustment Price, enter the numerical value for the percent to adjust your floor price
source.
In this example, the floor price is set to be 3% above the cost of the item.
Field Descriptions
FIELD DESCRIPTION
Floor Price Source Choose the Magento attribute that will indicate your relative floor
limit. For example, if you don’t want your product listing price to go
below the cost of your item, you would choose the attribute Cost.
l Increase By: Select this option if you want the defined price
source value to be increased before listing to Amazon.
Floor Adjustment Enter the numerical value for the percent to adjust your Floor
Amount Price Source.
l Price Adjustment
l Floor Price
l Optional Ceiling Price
The automated limit settings are used to help protect the ceiling pricing against the intelligent
pricing rules. This allows the store owner to set a high-price-limit for their intelligent pricing
rules.
Select your Magento attribute which will indicate your relative ceiling limit. For example, if you don’t
want your product listing price to go above the MSRP of your item, you would choose the
Manufacturer's Suggested Retail Price attribute.
l Decrease By: Select this option if you want the defined ceiling price source value to be
decreased before listing to Amazon.
l Increase By: Select this option if you want the defined ceiling price source value to be
increased before listing to Amazon.
l Match: Select this option if you want to change your Amazon listing price to match the
lowest competitor price, based on your competitor feedback and variance parameters.
When selected, the Apply and Ceiling Adjustment Amount fields are disabled.
4. For Ceiling Adjustment Price, enter the numerical value for the percent to adjust your floor
price source.
In this example, the ceiling price is set to be 2% below the MSRP of the item.
Field Descriptions
FIELD DESCRIPTION
Ceiling Price Source Choose the Magento attribute that will indicate your relative ceiling
limit. For example, if you don’t want your product listing price to go
above the MSRP of your item, you would choose the Manufacturer's
Suggested Retail Price attribute.
l Increase By: Select this option if you want the defined price
source value to be increased before listing to Amazon.
Ceiling Adjustment Enter the numerical value for the percent to adjust your Ceiling
Amount Price Source.
If Discard Subsequent Rules is set to Yes, the rules with lower priority (higher numbers) will
not apply to the eligible products.
For example, let’s say we have three pricing rules set up:
In this scenario, rules #1 and #2 would apply to the eligible products. Rule #3 would only
apply to eligible products not contained within Rule #2. This is because it has a lower priority
than #2 and Discard Subsequent Rules is set to Yes. So, the eligible products in the sale
category would receive 10% off and $2 off their Amazon listing price.
Priority 1 2
rule
percentage
Adjustment Amount 10 10
Product 1:
Price: $45.49
The final price after Rule 1 and Rule 2 are applied: $30.94
Product 2:
Price: $47.76
The final price after Rule 1 and Rule 2 are applied: $32.98
Priority 1
Product 1:
Price: $15
Because the Buy Box price is less than the original price, the product is listed at the original
price.
Product 2:
Price: $5
Because the Buy Box price is greater than the original price, the product is listed at the Buy
Box price.
Buy Box price, Floor Price Source: Price, and a 20% price decrease
FIELD SETTING
Rule Name rule-1
Priority 1
Product 1:
Price: $20
Because the Buy Box price is less than the Calculated Floor Price, the product is listed at the
Calculated Floor Price.
Product 2:
Price: $15
Because the Buy Box price is greater than the Calculated Floor Price, the product is listed at
the Buy Box price.
Product 3:
Price: $17
Because the Buy Box price is greater than the Calculated Floor Price, the product is listed at
the Buy Box price.
Lowest Price, All Competitor's Prices, and Use all competitor's product
conditions
FIELD SETTING
Rule Name rule-1
Priority 1
Feedback
PRICE CONDITION
$17 New
$15 New
Product 1:
Price: $10
Condition: New
Because the lowest competitor price for the New condition is $15, the product is listed at $15.
Product 2:
Price: $10
Because the lowest competitor price for the Used condition is $13, the product is listed at $13.
VAT
FIELD SETTING
VAT 10%
VAT
FIELD SETTING
Priority 1
VAT 10%
FIELD SETTING
Priority 2
When the ceiling price is hit, the standard pricing rule will be applied on top of the intelligent
pricing rule.
Final price after the standard pricing rule is applied: $13.75 + $5.00 = $18.75
Price Adjustment
In this example, we have chosen to define our most competitive price by looking at our
Amazon competitor’s lowest price who also have 95% positive feedback and a minimum
feedback count of 1,000 merchant reviews.
After running this search based on these parameters, our competitive price comes back at $25.
From here, we have three different Price Action choices based on this lowest price.
FIELD DESCRIPTION
Price Action l Decrease By – This option will decrease your listing price
relative to the lowest competitor price.
Adjustment Amount Numerical value to define the percentage or fixed amount for the
discount to be applied.
Floor price
FIELD SETTING
Floor Price Source Cost = $5
Floor price calculation = Floor Price Source [$5] * Floor Adjustment Amount [5%] = $5.25
This means that when our intelligent pricing rule is applied, it will not allow the listing price
to be lower than $5.25 for this specific product when the cost is $5.
If you change your catalog price scope from global to website, all price type attributes will also
change to website scope. For more information, see Adding Websites.
When a website price is selected, there are two price sources: the website price and the default
(fall back) price. For the Amazon integration, based on your Listing Rules, you can map
products from multiple websites into a single Amazon marketplace. However, this introduces
the issue of which price should be published if the product exists on multiple websites with
differing prices.
To determine which price will be used if a product is on two websites and has a varying price
per website, we use price priority logic (determined by the website priority).
To view your stores' sort order, on the Admin screen, tap Stores and then tap All Stores. In
the Web Site column, tap the website name. The Web Site Information screen contains the Sort
Order field, which determines the priority of the website. A value of ‘1’ indicates the highest
priority.
If the product price is set to Use Default, it will fall back to the default price value instead of
the website price value.
Store 1 1 $24.99 No
l Look at the website with the highest website priority, which is Store 1.
l Since Store 1 is set to use the website price (Use Default = No), the published price will be
$24.99.
Example 2:
WEBSITE PRICE
PRIORITY [WEBSITE] USE DEFAULT
Default 0 $31.99 --
Store 2 2 $27.99 No
l Look at the website with the highest website priority, which is Store 1.
l Since Store 1 is not set to use the website price (Use Default = Yes) look at the next website
in the sort order.
l Since Store 2 is set to use the website price (Use Default = No), the published price will be
$27.99.
Example 3:
WEBSITE PRICE
PRIORITY [WEBSITE] NON-PRICE [WEBSITE]
Default 0 $31.99 $30.00
Store 1 1 $24.99 --
In this example we have added in the non-price value, which is used if you select another value
for the Magento Price Source in the Listing Price settings. The non-price value will always use
price as the fallback price.
l Look the website with the highest website priority, which is Store 1.
l Since Store 1 is not set to use the non-price attribute, look at the next website in the sort
order.
l Since Store 2 is set to use the non-price attribute (Non-Price [Website] = $20.00), the
published price will be $20.00
The Buy Box Competitor Pricing tab displays the Buy Box listing price, shipping price, and
landed price of your competitors. This can be used to understand the price positioning of your
competitors on Amazon.
Intelligent repricing rules can be configured to adjust your pricing based on the Amazon Buy
Box price.
For books, the ASIN is the same as the ISBN number, but for all
other products a new ASIN is created when the item is uploaded
to your catalog. You can find an item's ASIN on the product
detail page along with additional details relating to the item
(such as size, number of pages, or number of discs).
Is Seller Whether or not the seller has won the Buy Box position for the
listing.
Landed Price The listing price for the product plus its shipping price.
Last Updated The date the Buy Box pricing was last updated.
Intelligent repricing rules can be configured to adjust your pricing based on the competitor
prices.
Default Columns
COLUMN DESCRIPTION
ASIN A unique block of 10 letters and/or numbers that identify items.
Landed Price The listing price for the product plus its shipping price.
Feedback Rating The average rating of the competitor from their customers (0 -
100).
Feedback Count The number of ratings of the competitor from their customers.
Last Updated The date the competitor pricing was last updated.
The Product Listings screen contains several tabs from which you can view the statuses of all of
your listings as well as match your products to Amazon listings.
Each tab differs slightly in the tasks available in the Actions drop-down, the Select (Action
column) drop-down, and the default and available table columns, but the workspace controls
are the same and allow you to customize the data that is displayed.
The Actions drop-down options can apply the selected action to all listings selected (checked),
while options in the Select drop-down in the Action column apply the action only to the
individual listing.
2. In the Amazon Stores tab, tap the store name for which you want to view listings.
Each tab differs slightly in the tasks available in the Actions drop-down, the Select (Action
column) drop-down, and the default and available table columns, but the workspace controls
are the same and allow you to customize the data that is displayed.
The Actions drop-down options can apply the selected action to all listings selected (checked),
while options in the Select drop-down in the Action column apply the action only to the
individual listing.
New Third Displays your existing Amazon listings l Create New Catalog Product(s)
Party (based on information received from l Attempt Automatic Match
Amazon) that are not matched to a
l Assign Catalog Product
product in your Magento catalog.
l Create New Catalog Product
l View Details
Ready to Displays your catalog products that are l Publish Product to Amazon
List ready to create new Amazon listings, but l Publish On Amazon
your store is set not to automatically
l View Details
publish new listings. This tab is used to
manually publish your new listings.
Inactive Displays your catalog products that have l End Listing(s) on Amazon
been published to Amazon, but Amazon
l Edit Listing Overrides
has not approved the listing for Active
status. l View Details
l Create Override
l Switch to Fulfilled by
Amazon/Merchant
l End Listing
Active Displays your Amazon listings that have l End Listing(s) on Amazon
been matched to a product in your l Edit Listing Overrides
Magento catalog, have been published to
l Switch to Fulfilled by
Amazon/Merchant
l End Listing
Overrides Displays your Amazon listings that meet l Edit Listing Overrides
the criteria for a defined override and to l Edit Overrides
which the override has been applied.
l View Details
Overrides take priority over any other
account setting.
l Create Override
l Switch to Fulfilled by
Amazon/Merchant
l End Listing
Ended Displays your Amazon listings that have l Publish Product to Amazon
manually been ended (removed) from l View Details
Amazon.
l Publish On Amazon
2. In the Amazon Stores tab, tap the store name for which you want to view listings.
There are four possible causes for an incomplete listing, each identified by its status.
Unable to Assign to Automatic match of this listing to your Manually assign an ASIN
Amazon Listing catalog failed. If no match is found, the to the catalog product to
listing cannot be managed by Amazon match to the listing.
Sales Channel
Multiple Matches Automatic match of this listing to your Manually select the
Found catalog failed. If multiple possible matches catalog product to match
are found, you must select the correct to this listing.
match for your product.
Has Variants If your product has variants, such as a t- View the variants that are
shirt that is available in different sizes or associated with your
colors, you must select the variant in
product and choose the
your catalog to be correctly assigned and
correct variant to assign
matched to the listing
and match to this listing.
When incomplete listings are properly matched to your catalog products, the listing will move from
the Incomplete tab and will publish to Amazon based on your Product Listing Actions setting.
There are three available actions on this tab to correct an Incomplete listing.
l Re-attempt to auto match to Amazon listings: Selecting this option initiates the automatic
process for matching your Amazon listings data to your Magento catalog. If products are not
automatically matching, revisit your Catalog Search options in your listing lettings. If
listings don't automatically match after updating your Catalog Search options, you can
match products manually in the Update Required Info action.
l View Details: Select this option to view listing details, including the Listing Activity Log,
Buy Box Competitor Pricing, and Lowest Competitor Pricing. This action is for viewing only.
No changes can be made in the listing details. See View Details.
Note: If you have listings in process, the number of listings will display in a message above the
tabs
Incomplete Listings
Amazon Sales Channel Home tabs share some common workspace controls that allow you to
customize the data that is displayed.
Default Columns
COLUMN DESCRIPTION
Amazon Seller SKU The SKU (Stock Keeping Unit) assigned by Amazon to a product
to identify the product, options, price, and manufacturer.
Landed Price The listing price for the product plus its shipping price.
Amazon Quantity The quantity available once the product is actively listed on
Amazon.
l Create New Catalog Product(s): Select this option to use the information in the Amazon
listing to automatically create a new product in your Magento catalog. This process will
automatically match the Amazon listing to the new catalog product. See Creating and
Assigning Catalog Products.
l Attempt Automatic Match: Select this option to prompt Amazon Sales Channel will
automatically attempt to match the selected listings to your catalog based on your current
Catalog Search options in your Listing Settings. If you modify your Catalog Search options,
this action will allow you to attempt the matching process again.
l Assign Catalog Product: Select this option to manually match the listing with a product in
your Magento catalog. See Creating and Assigning Catalog Products.
l Create New Catalog Product: Select this option to use the information in the Amazon
listing to automatically create a new product in your Magento catalog. This process will
automatically match the Amazon listing to the new catalog product. See Creating and
Assigning Catalog Products.
l View Details: Select this option to view listing details, including the Listing Activity Log,
Buy Box Competitor Pricing, and Lowest Competitor Pricing. This action is for viewing only.
No changes can be made in the listing details. See View Details.
Note: If you have listings in process, a message will be displayed above the tabs indicating
how many.
Amazon Sales Channel Home tabs share some common workspace controls that allow you to
customize the data that is displayed.
Default Columns
COLUMN DESCRIPTION
Amazon Seller SKU The SKU (Stock Keeping Unit) assigned by Amazon to a product
to identify the product, options, price, and manufacturer.
Listed Price Identifies the listing price for the item, as defined by the price
source and any applicable pricing rules.
Amazon Quantity The quantity available once the product is actively listed on
Amazon.
The Ready to List tab only displays when your Automatic List Action field in your listing
settings is set to "Do Not Automatically List Eligible Products." This setting tells Amazon Sales
Channel that any new Amazon listings must be published manually.
When the field is set to "Automatically List Eligible Products," Amazon Sales Channel
automatically publishes new listings for your eligible catalog products. Since new listings are
published automatically, this tab does not display.
In this tab, you can sort your active published listings using the columns provided, or add and
remove columns as needed. You can also perform several actions for a listing.
Listing information is published to Amazon based on your cron settings. Listing information will send
to Amazon at the next data sync. Until Amazon replies with the listing confirmation, the manually
published listing(s) remains on the Ready to List tab with a status of "List in Progress." Once the
listing confirmation is received from Amazon, the listing(s) removes from the Ready to List tab and
displays in the Active tab with a status of "Active."
Note: If you have listings in process, the number of listings will display in a message above the
tabs
Default Columns
COLUMN DESCRIPTION
Amazon Seller SKU The SKU (Stock Keeping Unit) assigned by Amazon to a product
Landed Price The listing price for the product plus its shipping price.
Amazon Quantity The quantity available once the product is actively listed on
Amazon.
COLUMN DESCRIPTION
List in Progress
The product listing has been submitted to Amazon, and is awaiting confirmation of
acceptance from Amazon.
l End Listing(s) on Amazon: Select this option to remove all selected listings from the
Amazon marketplace. See Ended Listings.
l Edit Listing Overrides: Select this option to change the override settings for the listing. See
Overrides.
l View Details: Select this option to view listing details, including the Listing Activity Log,
Buy Box Competitor Pricing, and Lowest Competitor Pricing. This action is for viewing only.
No changes can be made in the listing details. See View Details.
l Create Override: Select this option to create a new override and apply it to this listing. See
Creating Listing Overrides.
l Edit Assigned ASIN: Select this option to modify the ASIN assigned to your catalog
product. This would be used if a product in your catalog was matched to the wrong ASIN.
See Edit Assigned ASIN.
l Create Alias Seller SKU: Select this option to create an Alias SKU that can be used to create
a new Amazon listing from the same catalog product. See Creating an Alias Seller SKU.
l End Listing: Select this option to remove the listing from the Amazon marketplace. See
Ended Listings.
Note: If you have listings in process, a message will be displayed above the tabs indicating
how many.
Amazon Sales Channel Home tabs share some common workspace controls that allow you to
customize the data that is displayed.
Default Columns
COLUMN DESCRIPTION
Amazon Seller SKU The SKU (Stock Keeping Unit) assigned by Amazon to a product
to identify the product, options, price, and manufacturer.
Landed Price The listing price for the product plus its shipping price.
Amazon Quantity The quantity available once the product is actively listed on
Amazon.
Inactive Reason (if Amazon will not always provide a reason for inactive listings,
provided by Amazon) and you may need to reach out to customer support to resolve
listing issues. In some instances, Amazon will notify you of a
reason. To view these responses, in the Actions column, tap View
Details.
If these issues are resolved and Amazon lifts the error, the
products will change to Active listings and move to the Active
listings table.
l End Listing(s) on Amazon: Select this option to remove all selected listings from the
Amazon marketplace. See Ended Listings.
l Edit Listing Overrides: Select this option to change the override settings for the listing. See
Overrides.
l View Details: Select this option to view listing details, including the Listing Activity Log,
Buy Box Competitor Pricing, and Lowest Competitor Pricing. This action is for viewing only.
No changes can be made in the listing details. See View Details.
l Create Override: Select this option to create a new override and apply it to this listing. See
Creating Listing Overrides.
l Edit Assigned ASIN: Select this option to modify the ASIN assigned to your catalog
product. This would be used if a product in your catalog was matched to the wrong ASIN.
See Edit Assigned ASIN.
l Create Alias Seller SKU: Select this option to create an Alias SKU that can be used to create
a new Amazon listing from the same catalog product. See Creating an Alias Seller SKU.
l End Listing: Select this option to remove the listing from the Amazon marketplace. See
Ended Listings.
Note: If you have listings in process, the number of listings will display in a message above the
tabs
Amazon Sales Channel Home tabs share some common workspace controls that allow you to
customize the data that is displayed.
Default Columns
COLUMN DESCRIPTION
Amazon Seller SKU The SKU (Stock Keeping Unit) assigned by Amazon to a product
COLUMN DESCRIPTION
ASIN stands for the Amazon Standard Identification Numbers.
An ASIN is a unique block of 10 letters and/or numbers that
identify items. For books, the ASIN is the same as the ISBN
number, but for all other products a new ASIN is created when
the item is uploaded to their catalog. You can find an items ASIN
on the product detail page on Amazon, along with further details
relating to the item.
Landed Price The listing price for the product plus its shipping price.
Amazon Quantity The quantity available once the product is actively listed on
Amazon.
Buy Box Won Whether the product listing won the Buy Box position.
Types of Overrides
TAB DESCRIPTION
Price An override that sets the price of the listing, ignoring all other
price settings for the listing.
Handling Time An override that sets the handling time for a listing, ignoring the
default handling time set in listing settings.
Seller Notes An override that defines the Seller Notes section of the listing.
This field can be used to add additional information related to
the product or the override applied, typically used to describe the
condition of "non-new" products. Text in this field displays with
the listing for the shopper. Seller notes can not be added for a
listing with a condition value of "New."
You can create, edit, or remove an override for a single listing. The Create Override action is
available in the Action column when viewing listings on the Inactive, Active, and Ineligible
tabs. The Edit Overrides action is only available in the Action column when a listing has an
override applied and is viewed on the Overrides tab.
You can also create, edit, or remove an override to multiple listings. The Edit Listing
Overrides action is available in the Actions drop-down when viewing listings on the Inactive,
Active, Overrides, and Ineligible tabs.
Removing an override tells the listing to use the values defined by your listing settings and
rules.
When defining an override, you can also choose to enter a single type of override or any
combination of the types.
Note: If you have listings in process, the number of listings will display in a message above the
tabs
Amazon Sales Channel Home tabs share some common workspace controls that allow you to
customize the data that is displayed.
Default Columns
COLUMN DESCRIPTION
Amazon Seller SKU The SKU (Stock Keeping Unit) assigned by Amazon to a product
to identify the product, options, price, and manufacturer.
Condition Override The new condition defined in the override. If the override applied
to the listing is not a condition override, "Not Selected" will
display.
Seller Notes Override The new seller notes defined in the override. If the override
applied to the listing is not a seller notes override, this column
will be blank.
Handling Override The new handling time defined in the override (in days). If the
override applied to the listing is not a handling time override,
this column will be blank.
List Price Override The new listing price defined in the override. If the override
applied to the listing is not a price override, "N/A" will display in
this column.
Optional Columns
COLUMN DESCRIPTION
Magento SKU The SKU (Stock Keeping Unit) assigned to a product in Magento
to identify the product, options, price, and manufacturer.
Store Name Identifies the name of the Amazon Sales Channel store to which
the order is assigned, as defined during store setup.
To move a product out of the Ineligible Listings tab, you may need to modify your listing rules
to allow your products to be eligible.
Note: If you have listings in process, the number of listings will display in a message above the
tabs.
Ineligible Listings
Amazon Sales Channel Home tabs share some common workspace controls that allow you to
customize the data that is displayed.
Default Columns
COLUMN DESCRIPTION
Amazon Seller SKU The SKU (Stock Keeping Unit) assigned by Amazon to a product
to identify the product, options, price, and manufacturer.
Landed Price The listing price for the product plus its shipping price.
Amazon Quantity The quantity available once the product is actively listed on
Amazon.
Note: If you have listings in process, the number of listings will display in a message above the
tabs
2. In the left-side column, tap to check each of the listings you wish to end.
2. In the Action column for the listing, tap Select and tap End Listing
When ending a listing, a confirmation message displays that the selected listing is being
processed to end. Ended listings can be managed on Ended tab in Manage Listings. Once
processed and removed from Amazon, the status for the listing will display as "Manually
Ended.". Ended listings will remain removed from Amazon until you manually republish the
listing using the Republish to Amazon action.
A confirmation message will display that the selected listing is being processed to publish.
Amazon Sales Channel Home tabs share some common workspace controls that allow you to
customize the data that is displayed.
Default Columns
COLUMN DESCRIPTION
Amazon Seller SKU The SKU (Stock Keeping Unit) assigned by Amazon to a product
Landed Price The listing price for the product plus its shipping price.
Amazon Quantity The quantity available once the product is actively listed on
Amazon.
COLUMN DESCRIPTION
Each tab differs slightly in the tasks available in the Actions drop-down, the Select (Action
column) drop-down, and the default and available table columns, but the workspace controls
are the same and allow you to customize the data that is displayed.
The Actions drop-down options can apply the selected action to all listings selected (checked),
while options in the Select drop-down in the Action column apply the action only to the
individual listing.
l Inactive
l Active
l Overrides
l Ineligible
l Ended
Create New Catalog Create a new Magento catalog product using l New Third Party
Product(s) the information imported with the Amazon
listing.
Attempt Automatic Attempt an automatic match between your l New Third Party
Match Magento catalog and your Amazon listings
based on the search criteria settings. To
attempt rematch, you must modify your
Listing and Catalog Search settings to
increase the potential for automatic
matching.
Assign Catalog Manually select a product that already exists l New Third Party
Product in your Magento catalog and assign it to the
Amazon listing.
Create New Catalog Create a new Magento catalog product using l New Third Party
Product the information imported with the Amazon
listing.
Publish Product to (Mass action) Used to re-list an listing that l Ready to List
Amazon has been ended or to manually list a product l Ended
that meets your listing rules eligibility, but
your Product Listing Actions is not set to
"Automatically list new products."
Create Override Manually create an "override" that will set the l Inactive
price, handling time, condition, and seller
l Active
notes text for an individual listing, ignoring
other listing defaults, settings, and rules. l Ineligible
Edit Assigned ASIN Used if the ASIN matched to your catalog l Inactive
product needs to be modified (example: if the
l Active
product was matched to the wrong listing
ASIN). l Ineligible
Assigning (or matching) your products to your Amazon listings is necessary to use the full
feature set of Amazon Sales Channel.
l The Price and Quantity are taken from the Amazon Listing
The rest of the necessary settings are determined by the Magento product settings you select
during creation.
Once created and matched, the listings remove from the New Third Party tab and display on
the Active tab.
2. Find the listing you wish to assign/match in the list and tap Select in the Action column.
Then tap Assign Catalog Product. The Assign Magento Catalog Product screen displays.
3. Browse for or filter the list using the workspace controls and locate the appropriate catalog
product to match to the listing.
4. When the correct product is located in the list, tap Assign Catalog Product in the Action
column.
Your product and listing are now matched. Amazon Sales Channel can now share product and
listing data with Amazon and manage your listing and its information, including listing price,
shipping price, stock/quantity, order information and status, and more.
2. Find the listing you wish to create in your Magento catalog and tap Select in the Action
column. Then tap Create New Catalog Product. The Create Magento Catalog Product screen
displays.
No: Select this option to make the product ineligible for your Magento storefront sales.
Tap the drop-down arrow and tap a category checkbox to select the product's category. Tap
Done when finished.
2. For Website Ids, select the website (storefront) for which the product to be associated.
The options in this list are dependent on your Magento store configuration settings.
"Default" is the default selection. The options in this list are dependent on your Magento
attribute sets you have configured.
4. For Visibility, select an option for the new product in the drop-down.
Not Visible Individually (default): The product is not included in your storefront listings,
although it might be available as a variation of another product.
Catalog and Search: The product is included in catalog listings and available for search
operations.
5. For Assign Tax Class, select an option for the product in the drop-down.
The options that display in this list are dependent on the tax classes you have configured.
The catalog product is created in your Magento catalog, and assigned to the Amazon listing
from which it was created. With the listing now matched to an existing Amazon listing, the
listing will remove from the New Third Party tab and display in the Active tab.
You can tap individual checkboxes in the left-side column or you can tap the drop-down arrow in the
top-left column and choose Select All or Select All on this Page.
3. Tap the Actions field. Then tap Create New Catalog Product(s).
4. Tap OK to accept the confirmation message. The Create Magento Catalog Product screen
displays.
Yes: Select this option to make the product eligible for your Magento storefront sales.
No: Select this option to make the product ineligible for your Magento storefront sales.
Tap the drop-down arrow and tap a category checkbox to select the product's category. Tap
Done when finished.
8. For Website Ids, select the website (storefront) for which the product to be associated.
The options in this list are dependent on your Magento store configuration settings.
"Default" is the default selection. The options in this list are dependent on your Magento
attribute sets you have configured.
10. For Visibility , select an option for the new product in the drop-down.
Not Visible Individually (default): The product is not included in your storefront listings,
although it might be available as a variation of another product.
Catalog and Search: The product is included in catalog listings and available for search
operations.
11. For Assign Tax Class, select an option for the product in the drop-down.
The options that display in this list are dependent on the tax classes you have configured.
The catalog products are created in your Magento catalog and assigned to the Amazon listing
from which it was created. With the listings now matched to their respective Amazon listing,
the listings will remove from the New Third Party tab and display in the Active tab.
Field Descriptions
FIELD DESCRIPTION
Enable Product(s) (Required) If enabled, the product will be visible in your Magento
storefront; if disabled, the product will not show in your Magento
storefront.
Categories You can enter the name of the category for your new product or select
a category by tapping the drop-down arrow to display your options.
Options are dependent on your categories configuration.
Website Ids (Required) Select the website (storefront) for which the product to be
associated. Options are dependent on your Magento store
configuration settings
Attribute Set Id Select an attribute set from the drop-down. Options are
dependent on your configured Magento attribute sets.
Visibility Options:
Assign Tax Class Assign a tax class to the new product from the drop-down.
Options are dependent on your configured tax classes.
2. In the Action column, tap Select and then tap Create Override. The Product Listing Overrides
screen displays.
3. Verify the Listing Details to ensure you are viewing the correct listing.
4. You can define a single override type or any combination of types for the listing (Price,
Handling Time, Condition, Seller Notes).
l Price: Tap the Change Listing Price radio button. Enter your defined price value in the
Price Override field.
l Handling Time: Tap the Change Handling Time radio button. Enter the defined time
value (in days) in the Handling Time Override field.
l Condition: Tap the Change Condition radio button. Select the correct option in the
Condition Override drop-down.
l Seller Notes: Tap the Change Seller Notes radio button. Enter your notes text in the
Seller Notes Override field.
The Product Listing Overrides screen closes. The status of the listing changes to "Relist in
Progress." The change will be published to Amazon with your next data sync (as configured in your
cron settings). The listing is also added to the Overrides tab.
The following example screen shows an override that defines a new price of $55, a new
handling time of 1 day, a new condition of "Used; Like New," and new Seller Note text.
2. In the Action column, tap Select and then tap Edit Overrides. The Product Listing Overrides
screen displays just as when creating an override.
3. Verify the Listing Details to ensure you are viewing the correct listing.
5. To edit your override settings, define the sections for the type you want to change (Price,
Handling Time, Condition, Seller Notes).
l Price: Tap the Change Listing Price radio button. Enter your defined price value for
Price Override.
l Handling Time: Tap the Change Handling Time radio button. Enter the defined time
value (in days) for Handling Time Override.
l Condition: Tap the Change Condition radio button. Select the correct option for
Condition Override.
l Seller Notes: Tap the Change Seller Notes radio button. Enter your notes text for
Seller Notes Override.
6. To remove an override type, tap the Remove radio button for each of the types you want to
remove. If not removed, the previously defined value remains in the override.
The Product Listing Overrides screen closes. The status of the listing changes to "Relist in
Progress." The change will be published to Amazon with your next data sync (as configured in your
cron settings). If not already listed, the listings are also added to the Overrides tab.
Piggybacking on the Create an Override example. The following example screen shows an edit
to the previously created override that defines a new price of $50, removes the Handling Time
override, and keeps the previous Condition and Seller Notes overrides.
1. View the listing on a Products Listings tab (Inactive, Active, Overrides, or Ineligible).
2. Tap the checkbox in the left-side column to select each of the listings you want to modify.
3. In the Actions drop-down, tap Edit Listing Overrides. The Product Listing Overrides screen
displays just as when creating an override.
4. To keep an override the same, ensure the No Change To radio button selected for the type. "No
Change To" is the default setting. Selecting this option leaves the previously defined override
value unchanged.
5. To edit your override settings, define the sections for the type you want to change (Price,
Handling Time, Condition, Seller Notes).
l Price: Tap the Change Listing Price radio button. Enter your defined price value for
Price Override.
l Handling Time: Tap the Change Handling Time radio button. Enter the defined time
value (in days) for Handling Time Override.
l Condition: Tap the Change Condition radio button. Select the correct option for
Condition Override.
l Seller Notes: Tap the Change Seller Notes radio button. Enter your notes text for
Seller Notes Override.
6. To remove an override type, tap the Remove radio button for each of the types you want to
remove. If not removed, the previously defined value remains in the override.
The Product Listing Overrides screen closes. The status of the listings changes to "Relist in
Progress." The change will be published to Amazon with your next data sync (as configured in your
cron settings). If not already listed, the listings are also added to the Overrides tab.
Override Types
OVERRIDE DESCRIPTION
Price Override A price override defines the price for the listings. This override
takes priority over all automated settings until the override is
removed.
The value that exists in the Handling Time Override box is either
your default handling time defined in your listing settings or your
defined override handling time. If you remove a handling time
override, the listing will default to the handling time defined in
your listing settings.
Condition Override To override the Listing Condition, select the Change Condition radio
button and then select the new condition from the Condition Override
drop-down.
Seller Notes Override For products in your catalog that are defined with a condition
other than "New," a seller note can be added to further detail your
product and its condition to potential buyers. You can enter a
seller note override for a "New" condition product, but Amazon will
not display the note.
To override the Seller Notes, select the Change Seller Notes radio
button and then enter the new note in the Seller Notes Override
field.
l Create an Alias Amazon Seller SKU for one of your Magento catalog products to control
region-specific listing information
Example: You are a seller in both the US and the Canada regions. Remember, each of your Amazon
Sales Channel stores can only be assigned one Amazon region during setup. This means that you
have an Amazon Sales Channel store with a defined US region and another store with a defined
Canada region. Both stores share your Magento catalog for listing information across both regions,
including the Amazon Seller SKU and ASIN product attributes. So, listings for the catalog product
would be the same in both stores, sharing pricing, stock/quantity, and other product attributes. But,
your stock for your Canada store ships from a Canada location, and your US store ships from a US
location. Thus, you need to control the listing quantity for the listing separately for each store. To
accomplish this type of region-specific control, you can create an Alias Amazon Seller SKU.
Essentially, you can create an Alias Amazon Seller SKU that is linked to the same catalog product
and can be used to republish the same listing in that region.
l Create an Alias Amazon Seller SKU and match one of your Magento catalog products to two
Amazon listings
Example: You have a catalog product that is matched to an Amazon listing. As Amazon frequently
has multiple listings that represent the same product, you discover another Amazon listing for the
same product, but Amazon has assigned a different ASIN to the listing. To increase your product
visibility to include, you want to match your catalog product to the different ASIN and create listings
for both ASIN values. To accomplish this, you can create an Alias Amazon Seller SKU.
Essentially, you can create an Alias Amazon Seller SKU that can be used to match a single catalog
product to a second Amazon listing and create a new listing for the newly matched ASIN. In this
scenario, you would have two Amazon listings for the same catalog product.
After you've created an Alias Amazon Seller SKU, you can use your listing settings, rules, and
overrides to control the listing information for the region. Product attributes that can be defined
per region for a listing include quantity/stock, fulfillment method, condition, product
eligibility, and handling time.
This must be a unique value not used for any other product or alias in your catalog.
This value auto-populates with the ASIN that is matched to your catalog product. Changing this value
will match your catalog product to two Amazon listings based on the ASIN.
Yes: Select this option to delete the listing and create a new listing using the new information
provided.
No: Select this option to create a new listing and keep the old listing unchanged.
This must be a unique value not used for any other product or alias in your catalog.
This value auto-populates with the ASIN that is matched to your catalog product. Changing this value
will match your catalog product to two Amazon listings based on the ASIN.
Yes: Select this option to delete the listing and create a new listing using the new information
provided.
No: Select this option to create a new listing and keep the old listing unchanged.
Field Descriptions
FIELD DESCRIPTION
Assign New Seller SKU Enter a new, unique alphanumeric value to be linked to the original
Amazon Seller SKU. This number is only used by Amazon Sales
Channel to match to your catalog product. You can use any SKU
value, but the value can only be used once in your catalog.
Assign New ASIN Enter the ASIN value for the listing to which you want to match your
catalog product. Only modify this field when matching a single
catalog product to the ASIN for another listing for the same product.
This value must match the ASIN assigned by Amazon or the listing
will not be rejected by Amazon.
No: Select this option to create a new listing and keep the old
listing unchanged. Both listings will display in the Active tab
once the new listing is created.
When an assigned ASIN is changed, Magento ends your Amazon listings attached to the old
ASIN, validates the ASIN with Amazon, creates a new listing for the updated ASIN, and
updates listing information in Amazon Sales Channel.
2. In the Action column, tap Edit Assigned ASIN. The Product Listing Update screen displays.
2. In the left-side column, tap to check each of the listings you wish to end.
2. In the Action column for the listing, tap Select and tap End Listing.
When ending a listing, a confirmation message displays that the selected listing is being
processed to end. Ended listings can be managed on the Ended tab in Manage Listings. Once
processed and removed from Amazon, the status for the listing will display as "Manually
Ended." Ended listings will remain removed from Amazon until you manually republish the
listing using the Republish to Amazon action.
2. In the Action column for the listing, tap Select and tapUpdate Required Info.
3. Review the catalog product information (SKU and Product Name) for which you are trying to
match to an Amazon listing.
4. For Assign ASIN, enter the ASIN assigned by Amazon for the listing you want to match to the
catalog product displayed.
The listing is now matched to your catalog, and the listing will be updated and published to
Amazon based on your cron and listing settings. The listing will move from the Incomplete tab.
2. In the Action column for the listing, tap Select and tapUpdate Required Info.
3. Review the catalog product information (SKU and Product Name) for which you are trying to
match to an Amazon listing.
4. For Select Correct Amazon Listing, select the correct ASIN for the listing you wish to match to
this product.
Catalog products that are identified as possible matches will display in the drop-down.
If none of the displayed options are correct, you can select "Manually Enter Correct ASIN" and
manually enter the ASIN for the product.
5. If entering the ASIN manually, enter the correct ASIN for Manually Assign ASIN.
2. In the Action column for the listing, tap Select and tapUpdate Required Info.
3. Review the catalog product information (SKU and Product Name) for which you are trying to
match to an Amazon listing.
4. For Select Correct Amazon Listing, select the correct ASIN for the listing you wish to match to
this product.
Catalog products that are identified as possible matches will display in the drop-down.
If none of the displayed options are correct, you can select "Manually Enter Correct ASIN" and
manually enter the ASIN for the product.
5. If entering the ASIN manually, enter the correct ASIN for Manually Assign ASIN.
2. In the Action column for the listing, tap Select and tapUpdate Required Info.
3. Review the catalog product information (SKU and Product Name) for which you are trying to
match to an Amazon listing.
l Listing Details: Product details including the Name and Amazon Seller SKU.
l Listing Activity Log: Historical record of all the changes that have occurred for this listing,
such as pricing and quantity/stock changes. No further actions are required. This is
provided for review to understand the change history.
l Buy Box Competitor Pricing: This displays data on Amazon's Buy Box status and
competitor pricing.
l Lowest Competitor Pricing: This displays the lowest Amazon competitor's pricing and
feedback information.
Amazon Sales Channel Home tabs share some common workspace controls that allow you to
customize the data that is displayed.
Listing Details
Displays product information includes:
l Amazon Name
Listing Details
l Amazon Seller SKU: Identifies the Stock Keeping Unit (SKU) defined for the listing.
l Comments: Provides additional details related to the type of listing action that occurred.
l Executed At: Identifies the date and time the action occurred.
l Is Seller: Identifies if you are the Buy Box seller. Options Yes/No.
l Listing Price: Identifies the price at which the listing was published.
l Landed Price: Identifies the listing price plus the shipping price for the listing.
l Last Updated: Identifies the date and time the pricing information was updated from
Amazon.
l Listing Price: Identifies the price at which the listing was published.
l Landed Price: Identifies the listing price plus the shipping price for the listing.
l Feedback Rating: Identifies the Amazon feedback rating for the lowest price merchant.
l Feedback Count: Identifies the Amazon feedback count for the lowest price merchant.
l Last Updated: Identifies the date and time the pricing information was updated from
Amazon.
l Orders that are in "Unshipped" status in your Amazon Seller Central account at the time of
store integration during onboarding.
l All new orders in your Amazon Seller Central account after store integration.
l Orders that existed in your Amazon Seller Central account at the time of store integration
but were in a status other than "Unshipped."
An Amazon order is added to the to the Orders tab when Amazon Sales Channel receives
information that Amazon has changed the order status from "Pending" to "Unshipped" in
Amazon Seller Central. Amazon places an order in "Pending" status while the order and the
payment method are verified. Remember, information sync depends on your cron settings and
the time it takes Amazon to process information.
You can review your Amazon order information on the Orders tab.
If your order settings are defined to create a corresponding Magento order for your Amazon
orders, you can manage your orders the same way you process your Magento orders. If your
order settings are set to not create corresponding Magento orders, you can review your order
information on the Orders tab but must manage your orders in Amazon Seller Central.
When managing Amazon orders in Amazon Sales Channel, you will use the Magento Order
Management processes and workflows. When you tap the Magento order number for the order,
the order displays in a new tab the same as if you accessed the order in Sales grid in the admin
panel.
3. If you want to view additional details for an individual order, tap View Amazon Order Details
in the Action column.
This displays the Amazon Order Details screen to view the details for the selected order.
4. If you want to manage an individual order, tap the number in the Magento Order Number
column.
Order Management
Default Columns
COLUMN DESCRIPTION
Amazon Order Number The order number generated by your Amazon Central Seller account
and imported into Magento.
Amazon Store Name The name of the Amazon store in which the order was placed. Click
the store name to view the store's dashboard.
Magento Order Number The corresponding order number created by Magento when the
order information is received from your Amazon Seller Central
account (if set to create a corresponding order in your order
settings). Tap the number to view and manage the order similar
to Processing a Magento Order.
Buyer Name The name of the person who placed the order as received from
Amazon Seller Central.
l Unshipped
l Shipped
l Canceled
l Completed
l Partially Shipped
Total The total dollar value of the order as received from Amazon Seller
Central.
Fulfillment Channel Identifies the party responsible for sorting, packing, and shipping of
an order. Options:
l Merchant
l Amazon
Items Unshipped The number of items in the order that have not yet been shipped.
Purchase Date The date of the purchase as received from Amazon Seller Central.
Latest Ship Date The latest date that Amazon Seller Central expects you to ship the
order so that it arrives on time. This is very important for maintaining
your Amazon Seller Central business score.
Last Action A custom message from Amazon Seller Central to Amazon Sales
Channel that explains the action was last taken for the order. This
allows the merchant to have a single location in Amazon Sales
Channel to view the status of Amazon Seller Central orders.
The last action text may let the store owner know that an Amazon
Seller Central order has been canceled, that the Amazon Seller
Central has successfully invoiced the order payment, that the
system attempted to create a new Magento order but was unable to,
or that a corresponding Magento order was successfully created.
Optional Columns
COLUMN DESCRIPTION
Order Id This is the identifier assigned by Magento for the Amazon order
when the order was received from Amazon and created in the
Amazon Sales Channel.
Merchant Id This is the number assigned by Magento to the Amazon store you
created and integrated with an Amazon Seller Central account.
Is Prime Identifies the order as using the Amazon Prime shipping option.
Options: Yes/No.
Is Replacement
Items Shipped Identifies the number of items in the order in Shipped status.
Order Settings define how Amazon orders are imported into and processed in Magento.
Beginning when you integrate Amazon Sales Channel with your Amazon Seller Central account
during onboarding, Amazon orders import and create new orders in Amazon Sales Channel.
Amazon orders are imported and create new orders when the Amazon sets the order status to
"Unshipped." Orders that existed in Amazon in any status other than "Unshipped" prior to
your store's integration will not import.
When an order is created on Amazon, it is not immediately imported into Amazon Sales
Channel. Amazon assigns a "Pending" status to newly created orders. Once Amazon verifies the
order and payment method, Amazon changes the order's status to "Unshipped." This status
change triggers Amazon Sales Channel to import the order and create a corresponding order.
Amazon Sales Channel creates a matching order that corresponds to the Amazon order. Orders
created in Amazon Sales Channel display and can be managed in the Orders tab in Amazon
Sales Channel Home.
l Disabled: Select this option if you do not want to create corresponding orders in
Magento when new orders are received from Amazon. When this option is selected, all
other fields on this screen are disabled.
l Enabled: Select this option if you want to create corresponding Magento orders when
new orders are received from Amazon. Magento orders are created based on Amazon
status and stock levels.
"Enabled" must be selected to manage Amazon orders in Amazon Sales Channel. When
"Disabled" is selected, your Amazon orders will display in the Orders tab but will not have a
corresponding Magento order number and cannot be managed in Amazon Sales Channel.
Information for these orders is for review only. You must manage these orders in your Amazon
Seller Central account.
l No Customer Creation (guest): Select this option if you do not want to create a
customer account in Magento using the imported customer data from the Amazon
order. When selected, this option tells Magento to process an imported Amazon order
the same way it processes a guest checkout in Magento.
l Build New Customer Account: Select this option if you want to create a New Customer
Account in Magento using the customer data imported with the Amazon order.
Selecting this option builds your customer database from your Amazon orders.
l Build Using Magento Order Number: Select this option if you want to create a unique
Magento order number for the corresponding Amazon order using the Magento
incrementally-assigned order ID.
l Build Using Amazon Order Number: Select this option if you want to create the
Magento order number using the corresponding Amazon-assigned order number.
Once an order is imported, the Amazon Order Number and the Magento Order Number display in
the Orders tab.
l Do Not Reserve Quantity: Select this option when you do not want your Magento stock
quantity affected by your Amazon orders. Select this option if you use Amazon for your
fulfillment process (FBA). When this option is selected and you receive an Amazon
order, the quantity ordered will not affect your Magento stock quantity.
l Reserve Quantity: Select this option when you want the order quantity in the Amazon
order to be "reserved" in your Magento stock quantity. When this option is selected and
you receive an Amazon order, the quantity ordered will "reserve" in your Magento stock
quantity to prevent your Magento stock from "over selling."
Remember, Amazon orders do not import into and create new orders in Magento until Amazon
verifies the order and payment method changes the order status to "Unshipped."
7. For Order Status (required), select an option from the drop-down. Options:
l Custom Order Status: Select this option when you want newly created orders imported
from Amazon to be assigned a status other than the default. When this option is
selected, the Processing Order Status field enables for you to select the status you want
to use for newly created orders imported from Amazon.
l Processing Order Status: Select an option in the drop-down. The options that display
in this field are based on the default status options in Magento. See Order Status. You
can also create a custom order status to display here for selection. To create a custom
order status, see Custom Order Status.
Order Settings
Field Descriptions
FIELD DESCRIPTION
Import Amazon Orders Options:
l Disabled: Select this option if you do not want to create
corresponding orders in Magento when new orders are
received from Amazon. When this option is selected, all other
fields on this screen are disabled.
Import Amazon Orders Select which Magento Store the Amazon orders will be associated
Into Magento Store with when they are created in the Magento Order grid. The list of
options in this drop-down is dependent on the Magento stores you
have set up in your configuration. See Stores.
l Reserve Quantity: Select this option when you want the order
quantity in the Amazon order to be "reserved" in your
Magento stock quantity. When this option is selected and you
receive an Amazon order, the quantity ordered will "reserve" in
your Magento stock quantity to prevent your Magento stock
from "over selling." The reserved quantity will not be available
for purchase through your Magento storefront.
l Default Order Status: Select this option when you want newly
created orders imported from Amazon to be assigned your
defined default order status for new orders. The default status
for new orders (unless you have created a custom order status
for new orders) is "Pending." See Processing Orders.
Processing Order Status Enables when Order Status is set to "Custom Order Status."
Select an option in the drop-down. The options that display in
this field are based on the default status options in Magento. See
Order Status. You can also create a custom order status to
display here for selection. To create a custom order status, see
Custom Order Status.
CREATE
FULFILLME MAGENTO MAGENT RESERVE RESERVE
NT INVENTOR AMAZON O INVENTOR INVENTOR
CHANNEL Y STATUS ORDER STATUS ORDER? Y = YES Y = NO
FBA In-stock/Out- Pending No Inventory Inventory
of-stock/Do not reserved not reserved
Not Manage
CREATE
FULFILLME MAGENTO MAGENT RESERVE RESERVE
NT INVENTOR AMAZON O INVENTOR INVENTOR
CHANNEL Y STATUS ORDER STATUS ORDER? Y = YES Y = NO
FBM In-stock/Out- Unshipped Yes Inventory Inventory
of-stock/Do reserved not reserved
Not Manage
CREATE
MAGENTO MAGENT
FULFILLMEN INVENTORY AMAZON ORDER O INVENTORY
T CHANNEL STATUS STATUS ORDER? RESERVED?
FBA In-stock/Out-of- Pending No No
stock/Do Not
Manage
CREATE
MAGENTO MAGENT
FULFILLMEN INVENTORY AMAZON ORDER O INVENTORY
T CHANNEL STATUS STATUS ORDER? RESERVED?
FBA In-stock/Out-of- PartiallyShipped No No
stock/Do Not
Manage
Iif an order is Fulfilled by Amazon (FBA) but an item is in "out of stock" status, Amazon Sales
Channel is unable to create a Magento order. This is a limitation of MSI integrations.
l The Order and Shipping Details tab displays additional detailed order information.
l The Order Items tab displays all items associated with the selected Amazon order.
l The Tracking tab displays tracking information associated with the selected Amazon order.
If an order is in "Unshipped" status, the Cancel Order option will display in the header bar.
3. Tap Cancel Order in the header bar. If the order is not in "Unshipped" status, "Cancel Order"
will not display.
5. Tap Cancel Order in the header bar. The order is canceled, and the Status column for the order
on the Order tab is updated to "Canceled."
Tracking Details
2. Verify the order's Status as Unshipped. Then tap View Amazon Order Details in the Action
column.
You will be prompted to enter a reason for the cancellation, and then confirm. The cancellation
notification will be sent to your Amazon Seller Central account, and the customer associated
with the order will be properly notified. The status of the corresponding Magento order will
change to Complete.
Orders can only be canceled if they are in an Unshipped status. If the order is pending or
partially shipped (unshipped), the order can only be canceled through your Amazon Seller
Central account.
When corresponding Magento orders are created for Amazon orders, the assigned number
displays in the Magento Order Number column. Tapping the order number opens the order in
the Magento order processing screen in a new tab. You can process the order as you do your
other Magento orders.
When processing an Amazon order, Amazon Sales Channel updates and syncs the order
information with your Amazon Seller Central account. Your cron settings determine how often
order information is synced between Amazon and Amazon Sales Channel.
l Issuing a credit/refund
l Fulfilling/shipping an order
l Create an invoice
l Cancel an order
If an order is in "Unshipped" status, you can cancel an Amazon order on the Amazon Order Details
screen. If an order has been shipped, it cannot be canceled.
The order is verified by Amazon. When verified, Amazon changes the status to
"Unshipped." With this status change, the order is updated in Amazon Sales Channel
and displayed in the Order tab.
The order details are updated. Amazon Sales Channel updates the order details with
the price, customer email, and customer name. During this update, the Amazon order
will create the corresponding Magento order in the Magento order management screen.
The Magento order number will display with the order information on the Orders tab.
A new customer account is created. If configured in your order settings and the
customer does not exist in your Magento database, a new customer is created in your
Magento database using the corresponding customer information from the Amazon
order. If you selected "No Customer Creation (guest)" in your order settings, the order
will follow the Magento guest process and not create a new customer in your database.
At this point, if your Magento system is integrated with an ERP/OMS/WMS, the order
will be picked up per the integration of a new order being placed and created inside
Magento.
The order is shipped. From the Magento order processing screen, you will ship the
order and add a tracking number. Once all items are marked in a "Shipped" status
l The status of the Magento order will change to "Complete."
l The status of the Amazon Sales Channel order will change to "Shipped."
l The tracking number will be synced to Amazon, and the status of the order in
Amazon will change to "Shipped."
l Shipping notifications will be sent to the customer via Amazon, not from
Magento (per Amazon’s policies).
The order is imported. The order is not imported into Amazon Sales Channel until the
order is assigned the "Shipped" status by Amazon. Since Amazon has the inventory for
this product, this prevents interference with your warehouse/inventory management.
The order details are updated. If configured in your order settings, the Amazon order
will create the corresponding Magento order and be created as an order with a status of
"Complete."
No actions are available for the logs or reports, as they are review-only features.
The following logs apply to Amazon Sales Channel and are not store specific. These logs can be
accessed on Amazon Sales Chanel Home.
l The Listing Changes Log displays the changes that have occurred in your Amazon Seller
Account as a reflection of your Amazon Sales Channel settings.
l The Communication Errors Log displays any reported communication errors with Amazon.
The following reports are store-specific and can be accessed when viewing each store's
dashboard.
l The Competitive Price Analysis report displays your Amazon landed price (listing price plus
shipping price) in relation to the Buy Box price and lowest competitor price.
l The Listing Improvements report displays all suggested listing improvements provided by
Amazon for the selected store.
Amazon Sales Channel Home tabs share some common workspace controls that allow you to
customize the data that is displayed.
Default Columns
COLUMN DESCRIPTION
Amazon Store Name The name of the store defined when the Amazon store was set
up. Refer to Store Integration.
Seller SKU The SKU (Stock Keeping Unit) assigned by Amazon to a product
to identify the product, options, price, and manufacturer.
Listing Action The type of change that was made to the listing.
Amazon Sales Channel Home tabs share some common workspace controls that allow you to
customize the data that is displayed.
Default Columns
COLUMN DESCRIPTION
Amazon Store Name The name of the store defined when the Amazon store was set
up. Refer to Store Integration.
Error Code The code received from Amazon to identify the error type.
Message The message that describes the error associated to the error code.
Default Columns
COLUMN DESCRIPTION
Amazon Seller SKU The SKU (Stock Keeping Unit) assigned by Amazon to a product
to identify the product, options, price, and manufacturer.
Your Landed Price Your listing price for the product plus its shipping price.
Lowest Landed Price The lowest landed price (listing price plus its shipping price)
from your Amazon competitors.
Condition (lowest price) The condition of the product listed at the lowest price.
Buy Box Landed Price The landed price (listing price plus its shipping price) of the Buy
Box position listing.
Is Seller (Buy Box) Whether or not you have won the Buy Box position for the listing
(NA indicates there is no Buy Box price for the listing).
Condition (Buy Box) The condition of the Buy Box position listing.
Listing Improvements
The Listing Improvements report displays products with suggestions from Amazon to improve
the listing quality. You can review these suggestions, which could help the performance of
products within the Amazon listing. No actions are available for the log. It is a review-only
feature.
A listing improvement received from Amazon does not prevent your product from being listed
with Amazon.
Default Columns
COLUMN DESCRIPTION
Amazon Seller SKU The SKU (Stock Keeping Unit) assigned by Amazon to a product
to identify the product, options, price, and manufacturer.
Alert Type Describes the type of issue with the listing. For example,
"Missing" indicates that there is a missing required attribute.
Field Name The field name in the Amazon seller listing details for which the
improvement is being recommended.
1162
Contents
In this section of the guide, you’ll learn how to Content Elements
create content and manage the presentation of
your store. Page Builder
Content Staging
1163
CHAPTER 60:
Content Menu
The term content marketing1 refers to the art of promoting your products or services by
providing valuable information to your customers at no charge. The quality of your content
helps distinguish your store from others, increases your visibility to search engines, and
provides support to your customers. This soft-sell approach is often more effective than
advertising, builds credibility and trust, and can turn your store into a destination. Content is
still king.
Your content should reflect the branding of your store, and be delivered with your distinctive
visual presentation and voice to convey your message. Use pictures to tell a story. Educate,
inspire, and entertain. Keep in mind that with quality content, sometimes less is more.
Content Menu
Menu Options
Pages
Create pages with text, images, blocks, variables, and
widgets, that can be incorporated into the navigation of
your store, and linked to other pages. Then, organize your
pages into a hierarchy with navigation.
Blocks
Create blocks of content without writing any code.
Blocks can contain text, images, and even video, and
can be assigned to any part of the page layout.
Banners (Deprecated)
Create banners that are triggered by promotions and that
appear only to customers in specific, targeted segments.
Dynamic Blocks
Widgets
Design
Learn to manage the visual presentation of your store,
apply themes, and schedule design changes.
Staging
Content Staging gives your business team the ability to
easily create, preview, and schedule a wide range of
content updates directly from the Admin of your store.
1167
Content Elements
In this section of the guide, you’ll learn how to Content Menu
create and manage content pages and blocks, and
use variables and widgets to add dynamic Pages
content. Core Content Pages
Workspace Controls
Adding a New Page
Using the Editor
Inserting a Link
Inserting an Image
Inserting a Widget
Inserting a Variable
Configuring the Editor
Adding a Lightbox or Slider
Using Media Storage
Page Hierarchy
Configuring Page Hierarchy
Adding a Node
Blocks
Adding a New Block
Adding Social Plugins
Positioning Blocks on a Page
Banners
Creating a Banner
Rotating Banners
Using Banners in Price Rules
Widgets
Widget Types
Creating a Widget
New Products List
1168
CHAPTER 61:
Pages
All content can be viewed in terms of its shelf life, just as any product in a store. Did you know
that the shelf life of social media content is less than twenty-four hours? The potential shelf life
of the content you create can help you decide where to invest your resources.
Content with a long shelf life is sometimes referred to as evergreen content 1. Examples of
evergreen content include customer success stories, "how to" instructions, and Frequently
Asked Questions (FAQ.) In contrast, content is perishable by nature includes events, industry
news, and press releases.
About Us
Core Content
The Magento demo store has examples of core content pages to help you get started. All of the
pages can be modified to meet your needs. Take a look at the following pages in your store, to
make sure that the content conveys your message, voice, and brand.
Home
The demo “Home” page includes a banner, an image
carousel, several static blocks with links, and a list of
new products.
About Us
The “About Us” page is linked from the footer of your
store. You can include images, video, links to press
releases and announcements. The sample page has an
image on the right, and one of a decorative sort to
indicate the end of the page.
Customer Service
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.
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.
Default Pages
The Default Pages configuration determines the landing page that is associated with the base
URL, and the corresponding home page. It also determines which page appears when a “Page
Not Found” error occurs, and if a breadcrumb trail appears at the top of each page.
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.”
Workspace Controls
The page workspace includes tools to help you quickly find the pages you need, and commands
to perform routine maintenance on individual or multiple pages. You can also quickly update
page properties from the grid.
Pages Grid
l Title
l URL Key
l Status
l Layout
Workspace Controls
CONTROL DESCRIPTION
Actions Lists all actions that can be applied to selected items in the list. To
apply an action to a page, or to multiple pages, mark the checkbox in
the first column of each record that is subject to the action. Options:
Delete
Disable
Enable
Edit
Select The control in the header of the first column can be used to select
multiple records as the target of action. Mark the checkbox in the first
column of each record that you want to select. Options: Select All /
Deselect All
Edit Opens the record in edit mode. You can accomplish the same thing
by clicking anywhere on the row.
Columns
COLUMN DESCRIPTION
Select The checkbox in the first column is used to select multiple records:
Options:
Select All
Deselect All
URL Key The URL key is similar to a file name, and identifies the page in the
URL.
Layout Determines if the page appears with sidebars to the right or left of the
main content area. Options:
1 column
2 columns with left bar
2 columns with right bar
3 columns
Empty
Store View Can be used to associate the page with a specific store view.
Page Search
The Search box in the upper-left of the page grid can be used to find specific pages by keyword.
For a more advanced search, you can filter the search by multiple parameters.
To search by keyword:
2. Tap Search ( ) to display the results. The results include all pages that contain the keyword.
To filter search:
3. Complete as many of the filters as necessary to describe the page(s) that you want to find.
Filtered Search
Search Filters
FILTER DESCRIPTION
ID Filter the search by page record ID.
Created Filter the search by the date the page was created.
Modified Filter the search based on the date the page was last modified.
Store View Filter the search based on store view. Options: (All available Store
Views)
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
Moving a Column
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:
To save a 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.
l To change the name of a view, tap the Edit ( ) icon. Then, update the name.
Choose a View
Scheduled Changes
Page changes can be applied on schedule, and grouped with other content changes. You can
create a new campaign based on scheduled changes to a page, or apply the changes to an
existing campaign. To learn more, see: Content Staging.
Scheduled Changes
The following instructions walk you through each step to create a basic page. Some advanced
features are skipped over, but are covered in other topics.
Pages
Process Overview:
Step 1: Add a New Page
Step 2: Complete the Content
Step 3: Complete the SEO Information
Step 4: Define the Scope
Step 5: Identify Parent Page (If applicable)
Step 6: Make Design Changes (Optional)
Step 7: Preview the Page
Step 8: Publish the Page
1. On the Admin sidebar, tap Content. Then under Elements, choose Pages.
New Page
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."
b. Enter the Page Title. The Page Title is the name that appears in the breadcrumb trail
navigation.
2. Complete the content, and format the text as needed. To learn more, see: Page Builder.
3. Tap Save.
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.
2. Tap Save.
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
Hierarchy
2. If this page is a child of another page, mark the checkbox of the Parent page.
Design
l Empty
l 1 column
l 3 columns
b. To include additional layout instructions, enter valid XML code in the Layout Update
XML box.
1. On the Save menu, choose Save & Close to return to the Pages grid..
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.
Save Menu
COMMAND DESCRIPTION
Save Save the current page, and continue working.
Save & New Save and close the current page, and begin a new page.
Save & Duplicate Save and close the current page, and open a new duplicate copy.
Save & Close Save and close the current page, and return to the Pages grid.
Duplicating a Page
Any content page can be used as a template, and saved as a duplicate. You might use this
time-saving technique to create a consistent design for content pages throughout your site. The
duplicate page retains the Page Title of the original, but the URL Key and Status fields must be
updated.
To duplicate a page:
1. On the Admin sidebar, choose Content. Then under Elements, choose Pages.
2. In the grid, find the page that you want to duplicate. Then in the Action column, open the
page in Edit mode.
3. On the Save menu, choose Save & Duplicate. Then, do the following:
a. Look for the messages that the page has been saved and duplicated. Then in the menu bar,
tap Back to return to the grid.
b. Find the duplicate page in the grid, and take note of the following:
a. If you want to publish the page at this time, set Enable Page to “Yes.”
c. Expand the Search Engine Optimization section. Then, enter the unique URL Key that
you want to use for the duplicate page.
Temporary URL Key
Save Menu
COMMAND DESCRIPTION
Save Save the current page, and continue working.
Save & New Save and close the current page, and begin a new page.
COMMAND DESCRIPTION
Save & Duplicate Save and close the current page, and open a new duplicate copy.
Save & Close Save and close the current page, and return to the Pages grid.
2. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
Default Pages
5. In the message at the top of the workspace, tap the Cache Management link, and refresh any
invalid caches.
Media Storage
Media storage helps you organize and gain access to media files that are stored on the server.
The path to the location of the files is determined by the Base URL configuration. Files in
media storage can be accessed from the editor while working on pages and static blocks. Media
storage is usually located in the file system on the same server as the Magento program files.
Media Storage
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.
c. Tap Open.
The images are uploaded to the current media storage folder on the server.
Media Storage
Open the page or block to be edited. Then, use one of the following methods to insert an image
from media storage:
3. In the directory tree on the left, navigate to the folder where the image is stored.
Insert File
TinyMCE 4 is now the default WYSIWYG editor. TinyMCE 3 is now deprecated, but can be enabled
in the configuration if required for previous customizations.
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.
4. In the Title field, enter the tooltip text to appear when someone hovers over the link.
Inserting an Image
From the editor, you can insert an image that has been uploaded to Media Storage, or link to
an image that resides on another server.
Media Storage
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.
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.
3. On the Editor toolbar, tap the Insert Image button. Then, do the following:
a. In the Image URL field, paste the full URL to the image on the other server.
Inserting a Widget
The Widget tool can be used to add a variety of content elements to the page, including links to
any content page or node, product, or category. Links can be positioned on the page in a block
format, or incorporated directly into the content. You can use the Widget tool to create links to
the following types of content:
l Content Pages
l Catalog Categories
l Catalog Products
By default, links inherit their style from the style sheet of the theme.
Inserting many directives, especially widgets like the Recently Viewed / Compared Products type,
can produce a negative effect on the first page load when the page is not cached. For this reason,
we advise that you use them with caution. In most cases, it should not create an issue. But this is
something that you should discuss with your development team.
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:
2. Position the cursor in the text where you want the widget to appear.
Method 2: HTML Mode
3. When prompted, choose the Widget Type. This example shows how to insert a link to a
product.
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.)
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.”
c. Click Insert Widget to place the link on the page. In the HTML, a markup tag for the link
appears at the top of the page, enclosed in double curly braces.
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.
You can continue editing the page, and incorporate other links into the content.
Inserting a Variable
Your store includes many predefined variables that can be incorporated into content pages and
other communications. In addition, you can include your own custom variables that are
specific to your needs.
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.
TinyMCE 4 is now the default WYSIWYG editor. The implemented version, which is actually
4.6, offers an improved user experience, and supports a wide range of WYSIWYG plugins.
TinyMCE 3 is now deprecated, but can be enabled in the configuration if required for previous
customizations.
WYSIWYG Options
a. Set Enable WYSIWYG Editor to your preference. The editor is enabled by default.
b. Set WYSIWYG Editor to the version of the TinyMCE editor that you want to use.
TinyMCE 4 is the recommended and default editor.
c. Set Static URLs for Media Content in WYSIWYG to your preference for all media content
that is entered with the WYSIWYG editor.
Page Hierarchy
Your store’s page hierarchy system gives you the ability to organize your content pages and add
pagination, navigation, and menus. The Privacy Policy page in the sample data is an example
of a page with a menu on the left. If you publish a large amount of content on a regular basis,
you can use page hierarchy to organize your content to make it easy for people to find articles
of interest.
The page hierarchy system uses nodes to identify related pieces of content, and to organize
content pages into a parent/child relationships. A parent node is like a folder that might
contain child nodes and pages. The relative position of each node and page in the hierarchy is
shown as a tree. A node might contain other nodes and content pages, and a single content
page might be associated with multiple nodes and other content pages in a parent/child or
neighbor relationships.
3. Expand the CMS Page Hierarchy section, and make any changes that are necessary.
Adding a Node
The following example shows how to create a node with simple navigation to related content
pages. Although a node does not have a content page associated with it, it does have a URL
Key which can be referenced elsewhere in your site.
For example, you might create a node called “Press Releases” that has navigation to individual
press releases. Then, you can include the link on your “About Us” page to the node. Or you
might create a node for a collection of back issues of your newsletter.
To link to a node, use the Widget tool to create a CMS Hierarchy Node Link. Then, place the
widget in a content block or page.
Process Overview:
Step 1: Create a Node
Step 2: Add Pages to the Node
Step 3: Define the Structure
Step 4: Add Pagination Controls
Step 5: Choose the Menu Layout
1. On the Admin sidebar, tap Content. Then under Elements, choose Hierarchy.
b. Enter a suitable URL Key in all lowercase characters, using hyphens to separate words,
instead of spaces.
Page Properties
c. Tap Save . The node appears as a folder in the tree on the left of the page.
2. Scroll down to the CMS pages section, and mark the checkbox of each page you want to
include in the hierarchy.
3. Tap Add Selected Pages(s) to Tree. Each selected page appears in the tree below the node folder.
1. If necessary, drag the pages into position to reflect the order that they are to appear in the
menu.
2. Click the node at the top of the hierarchy. The Page Properties section now displays
information about the node.
a. To identify the node as the top of the hierarchy, set First to “Yes.”
c. To organize the pages in the hierarchy as a book, set Enable Chapter/Section to “Yes.”
d. To assign the node to a specific part of the book, set Chapter/Section to one of the
following:
l Chapter
l Section
l Both
If you don’t want to include the node as part of the book, choose “None.”
Pagination Options
2. In the Frame field, enter the number of page links that you want to include in the pagination
control
3. If there are more pages in the hierarchy that can be included in the pagination control, do the
following:
In the Frame Skip field, enter the number of pages that you want to skip ahead (or back) for
the next set of pagination links.
a. Under Page Navigation Menu Options, set Show in Navigation Menu to “Yes”.
b. To specify the location of the menu in relation to the content, set Menu Layout ot one of
the following:
l Use Default
l Content
l Left Column
l Right Column
c. To specify how much detail is included in the menu, set Menu Detalization to one of the
following:
Neighbours and Includes subpages and other pages that re at the same level in the
Children hierarchy.
d. To determine the depth of the menu, set Maximal Depth to the maximum number of levels
to include.
e. To format the menu, choose the List Type and corresponding List Style.
Unordered The menu options are not numbered, and can be formatted with or
without bullets..
Ordered The menu options are numbered, and can be formatted as numeric,
alphabetic, or roman numerals in either upper-or lowercase.
If you want the node to be visible in the navigation menu, set Show in Navigation menu to
“Yes”.
Field Descriptions
FIELD DESCRIPTION
NODE PROPERTIES
This settings in this section apply only to top-level nodes and pages, and define the structure of the
hierarchy.
Next/Previous Adds Next and Previous page links so readers can browse in
sequence. Options: Yes / No
Enable Chapter/Section Determines if the content can be organized as a book, with chapters
and sections. Options: Yes / No
Enable Pagination Determines if a pagination control appears at the bottom of the each
page. Options: Yes / No
Frame Skip Specifies the number of pages to skip ahead if there are additional
pages beyond what is visible in the pagination control.
Show in Navigation Menu Determines if a navigational menu is generated for the page
hierarchy. Options: Yes / No
Menu Detalization Determines the level of detail that is to be included in the menu.
Options:
List Type Determines the style that is applied to the menu. Options:
Show in navigation menu Determines if the selected node is visible in the navigation menu.
Options: Yes / No
You can create custom blocks of content without writing any code, and assign them to appear
in a specific place in the page layout. Blocks can also be defined and positioned by making a
layout update in XML code.
The Blocks workspace uses the same basic controls as the Pages workspace to help you find
available blocks and perform routine maintenance.
Blocks Workspace
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:
a. By default the status of the new block is enabled. If you want to change the status, set
Enable Block to “No.”
c. Assign a unique Identifier for the block. Use all lowercase characters, with underscores
instead of spaces.
3. If you are using Page Builder, drag the content types that you need to the stage. Then, follow
the instructions for each content type.
4. If your Magento installation does not have Page Builder enabled, do the following:
l Use the editor 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.
Editor
The new block appears at the bottom of the list in the Blocks grid.
Save Menu
COMMAND DESCRIPTION
Save Save the current block, and continue working.
Save & New Save and close the current block, and begin a new block.
Save & Duplicate Save and close the current block, and open a new duplicate copy.
Save & Close Save and close the current block, and return to the Blocks grid.
Facebook Plugins
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:
b. Enter the Width in pixels that is available on your site for the button and any associated
text message.
l Like
l Recommend
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. If using Page Builder, add an HTML Code block to the stage, and paste the snippet of
code that you copied from the Facebook site. Otherwise, paste the snippet of code into the
Content box.
1. If using Page Builder, follow the instructions to add the block to the stage. Otherwise, on the
Admin sidebar, tap Content. Then under Elements, choose Widgets.
a. In the Settings section, set Type to “CMS Static Block.” Then, tap Continue.
c. Tap Continue.
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.
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."
6. Tap Select Block…. Then in the list, choose the block that you want to place.
8. When prompted, follow the instructions at the top of the workspace to update the index and
page cache.
Slider Extensions
To add a lightbox or slider to your store, download the extension from Magento Markeplace,
and follow the instructions to install the extension. For additional help, see the documentation
provided by the developer.
Positioning Blocks
The code that controls the page layout and placement of blocks is written in XML Widgets
make it easy to position a block at a specific place on the page, and even for a specific product
or category without writing any code. You can choose each option from a list, rather than
trying to remember all of the possible combinations.
The following list shows the locations by page type where blocks are typically placed. To learn
more about how areas on the page are defined, see: Standard Page Layouts.
My Cart Extra Actions Content appears below the Cart Subtotal in the My Cart popup
located within the top link.
Product Page
Bottom Block Options If custom options are added, content appears below the Add to Cart
Wrapper button.
Info Column Options If a custom options are added, content appears to the right. The
Wrapper same location applies to configurable options.
Main Content Area Content appears below the main content area.
My Cart Extra Actions Content appears below the Cart Subtotal in the My Cart popup
located within the top link.
PayPal Express Checkout If the PayPal payment method is enabled, content appears below the
(Payflow Edition) Shortcut PayPal buy button.
Wrapper
PayPal Express Checkout If the PayPal payment method is enabled, content appears below the
Shortcut Wrapper PayPal buy button.
Product Tags List Content appears below the products tag bar.
Product View Extra Hint Content appears below the main top price of the product.
Tags List Before Content appears above the Add Your Tags field.
Using a Widget
The CMS Static Block widget gives you the ability to place an existing content block most
anywhere in your store.
Process Overview:
Step 1: Choose the Type
Step 2: Complete the Layout Updates
Step 3: Place the Block
1. On the Admin sidebar, tap Content. Then under Elements, choose Widgets.
a. In the Settings section, set Type to “CMS Static Block.” Then, tap Continue.
c. Tap Continue.
Settings
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.
Storefront Properties
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:
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
2. Tap Select Block…. Then in the list, choose the block that you want to place.
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.
The term callout 1 is sometimes used to refer to a block that is defined as a layout update with
XML code. The term sidebar2 refers to the left or right columns of the page layout. When
entering layout update code, make sure to follow the syntax exactly as shown in the example.
To place a block in the sidebar, the page must have a two-or three-column layout. To learn more,
see: Page Layout.
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.
a. In the Layout Update XML box, enter the code for the right or left 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.
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.
1. On the Admin sidebar, choose Content. Under Elements, choose Dynamic Blocks.
Dynamic Blocks
2. In the upper-right corner, tap Add Dynamic Block. Then, do the following:
a. If applicable, set Store View to a specific store view where the dynamic block is to appear.
d. Set Dynamic Block Type to the area of the page where the dynamic block is to appear.
Then, tap Done.
e. In the Customer Segment list, mark the checkbox of each segment that you want to see
the dynamic block. Then, tap Done to save the setting.
1. Tap one of the following buttons to choose the type of promotion to associate with the dynamic
block:
2. In the list of available rules, mark the checkbox of each rule that you want to use. Then, tap
Add Selected.
1. Open the page where you want the dynamic block to appear.
2. Use the Add Dynamic Block content type to add the dynamic block to the stage.
Field Descriptions
FIELD DESCRIPTION
Store View Specifies the store view(s) where the dynamic block is to be
available.
Enable Dynamic Block Activates or deactivates the dynamic block. Options: Yes /No
Dynamic Block Name A descriptive name that identifies the dynamic block in the Admin.
Dynamic Block Type Identifies the place in the standard page layout where the dynamic
block is placed. Options:
Customer Segment Associates a customer segment with the dynamic block to determine
which customers can see it.
CONTENT
Elements Add text, headings, buttons, dividers, and HTML code to any layout
container on the stage.
Media Add images, video, banners, sliders, and Google Maps to any
existing layout container on the stage.
Add Content Add existing blocks, dynamic blocks, and products to the stage.
RELATED PROMOTIONS
Related Cart Price Rule Associate an existing cart price rule with the dynamic block as a
promotion.
Add Cart Price Mark the checkbox of each cart price rule
Rules that is related to the dynamic block. Then,
tap Add Selected.
Related Catalog Price Associate an existing catalog price rule with the dynamic block as a
Rule promotion.
Add Catalog Price Mark the checkbox of each catalog price rule
Rules that is related to the dynamic block. Then,
tap Add Selected.
Process Overview:
Step 1: Create Individual Dynamic Blocks
Step 2: Add a Dynamic Block Rotator Widget
Step 3: Complete the Options
Follow the instructions to create the dynamic blocks that you want to place in the rotator.
1. On the Admin sidebar, choose Content. Then under Elements, choose Widgets.
b. Choose the current Design Theme of the store. Then, tap Continue.
Settings
b. In the Assign to Store Views list, select the view where the rotator will be available.
c. (Optional) Enter a Sort Order number to determine the position of the rotator in the
target container, relative to other widgets that might be assigned to the same container.
Storefront Properties
2. Under Layout Options, tap Add Layout Update. Then, do the following:
a. Set Display on to the page, or type of page, where the rotator is to appear.
The options vary, depending on the display option you choose. In this example, the
rotator is to be placed on a “Specified Page.”
c. Set Container to the part of the page layout where the rotator is to appear.
If other widgets are assigned to the same container, they appear in sequence according to
the sort order.
Layout Updates
3. In the panel on the left, choose Widget Options. Then, do the following:
b. To Restrict the Dynamic Block Types that can be used with the widget, select “Content
Area.”
Widget Options
d. In the Specify Dynamic Blocks grid, mark the checkbox of each dynamic block that you
want to include in the rotator.
Field Descriptions
FIELD DESCRIPTION
SETTINGS
Design Package/Theme Identifies the current package or theme that determines the page
layout of the store.
STOREFRONT PROPERTIES
Widget Title A descriptive title for internal use, that identifies the rotator.
Assign to Store Views Determines the store view(s) where the rotator is available.
Sort Order Determines the position of the rotator in relation to other widgets
which might be assigned to the same container on the page.
LAYOUT UPDATES
Add Layout Update Adds a layout update that determines where the rotator is to appear
on the store.
Display on Determines the type of page, or a specific page, where the rotator is
to appear.
Configurable Product
Grouped Product
Container Identifies the position on the page where the rotator is placed.
Template Determines the template that is used to format the rotator, based on
whether the rotator is to stand alone, or be placed inside existing text.
Options:
Dynamic Block Template
Dynamic Block Inline Template
WIDGET OPTIONS
Dynamic Blocks to Determines the type of dynamic blocks are included in the rotator.
Display Options:
Restrict by Dynamic Block Limits the banner to a specific part of the page layout. Options:
Types
Content Area Places the dynamic block in the main
content area of the page.
Rotation Mode Determines the presentation and order of the dynamic blocks as they
appear in the rotator. Options:
Specify Dynamic Blocks Displays a grid of the available dynamic blocks, and includes all
selected dynamic blocks in the rotator.
1. On the Admin sidebar, tap Marketing. Then, under Promotions, choose one of the following:
2. In the grid, find the rule that you want to associate with the dynamic block, and open in edit
mode.
3. Scroll down and expand the Related Dynamic Blocks section. Then, do the following:
a. In the first column, set the filter to “Any.” Then, click Reset Filter. The grid now lists all
available dynamic blocks.
b. Mark the checkbox of each dynamic block that you want to associate with the rule.
1. On the Admin sidebar, tap Content. Then, under Elements, choose Dynamic Blocks.
2. Find the dynamic block in the grid, and open in edit mode. Then, scroll down and expand the
Related Promotions section.
3. Any currently associated price rules appear in the grid. You can either add a new associated
rule, or remove a current association. Do the following:
Related Promotions
4. In the grid, mark the checkbox of each rule that you want to associate with the dynamic block.
Then, tap Add Selected.
Banners can be used to display an image or block of content, and appear for a specific period of
time for a promotion. You can create banners that are visible only to certain customer
segments, or whenever price rule conditions and coupons apply.
When designing banners for your store, take into consideration both the page layout and the
theme you are using. Banners are often designed to appear on a specific page, and in a specific
part of the page layout. Although the header and footer are a fixed width, the width of the
content area and sidebars, can vary according to theme and page layout. When designing a
banner with graphic images, it is important to understand the page layout, so you can put the
available space to best use.
Creating a Banner
DEPRECATED: Page Builder’s advanced content tools replace the previous banner functionality as
described in this topic. We keep this content in the user guide as a convenience for those whose
stores have customizations that prevent them from using Page Builder.
Process Overview:
Step 1: Complete the Banner Properties
Step 2: Complete the Banner Content
Step 3: Choose a Related Promotion (optional)
Step 4: Place the Banner
1. On the Admin sidebar, tap Content. Then under Elements, choose Banners.
This setting determines the location on the page where the banner is placed. (To select
more than one, hold the Ctrl key down and click each option.)
Banner Properties
d. If the banner is to be used for a specific customer segment, set Customer Segments to
“Specified.” Then, choose each customer segment that is associated with the banner.
2. If the banner is to use the same content for each store view, clear the No Default Content
checkbox.
Default Content
3. In the text box, enter the HTML code that is needed to format the banner. Then, do any of the
following:
Insert Widget
Insert Image
2. In the text box, position the cursor where you want the image tag to be inserted.
Insert Variable
1. To insert a variable, tap Insert Variable. Then, choose the variable that you want to insert.
2. Complete the HTML as needed. Depending on the content, the text box might contain a
combination of HTML and markup tags.
a. In the Store View Specific Content box after the name of the store view, clear the Use
Default checkbox.
b. Follow the instructions in the previous step to enter the banner content for the store view.
2. Scroll down through the list of available promotions for the type of price rule, and mark the
checkbox of each promotion that can be used with the banner.
Related Promotions
Banner Saved
Footer The bottom section of the page contains the footer links and
copyright notice.
Header The top section of the page contains your logo, account links, search
box, and top navigation.
Rotating Banners
DEPRECATED: Page Builder’s advanced content tools replace the previous banner functionality as
described in this topic. We keep this content in the user guide as a convenience for those whose
stores have customizations that prevent them from using Page Builder.
A banner rotator can be used to display a single banner, or multiple banners in a specific
sequence or random order. The next banner in the sequence appears whenever the page is
refreshed.
The banner rotator is a widget that can be assigned to a specific page, product, or category, and
placed most anywhere in your store. In addition, banner rotators can be associated with a
specific cart or catalog price rule.
Process Overview:
Step 1: Create the Individual Banners
Step 2: Add a Widget
Step 3: Configure the Banner Rotator
Create the individual banners that you want to include in the rotator.
l Under Layout Updates, choose the page and location where the banner rotator is to appear.
b. (Optional) To limit the banner to a certain area of the page, set Restrict by Banner Types
to the place on the page where you want the banner to appear.
a. In the Specify Banners section, use Search to find the banners you want to include. If
necessary, tap Reset Filter to list all the available banners.
b. Mark the checkbox of each banner you want to include in the rotator.
c. To set the sequence of each banner in relation to the others, enter a number in the
Position column. To place a banner in the first position, enter the number 1.
Categories Displays the banner rotator for only the categories selected.
Rotation Mode Select the rotation mode for the banners. Options:
One at the time, Displays the banners that you specify by the
Series order of their position every time the page is
refreshed.
Specify Banners Select the banners to include from the list of available banners.
Any banners you create can be associated with both catalog and cart price rules for a
promotion. To associate a banner with a price rule, you must first create both the banner and
the price rule. Related banners can be associated with a price rule from the Banner tool, or from
either the Cart Price Rule or Catalog Price Rule tool.
Related Banners
2. In the grid, open the rule that is to have the banner. Then, do the following:
a. Scroll down and expand the Related Banners section to display the lists of available
Cart and Catalog Price Rules.
Related Promotions
b. If necessary, use the search filters to find the price rule(s) that you want. Then, mark the
checkbox of each banner that you want to associate with the price rule.
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.
Inserting many directives, especially widgets like the Recently Viewed / Compared Products type,
can produce a negative effect on the first page load when the page is not cached. For this reason,
we advise that you use them with caution. In most cases, it should not create an issue. But this is
something that you should discuss with your development team.
Widget Types
Widgets
TYPE DESCRIPTION
Banner Rotator (Deprecated - Available only if Page Builder is not enabled) Can be
used to display a single banner, or an assortment of banners in a
series, random order, or shuffled. The banner can be triggered by
price rules, and placed on a specific page and location, or configured
to appear on all pages.
CMS Hierarchy Node Link Displays a link to a specific node in the page hierarchy that can be
incorporated into other content.
CMS Page Link Displays a link to a specific CMS page. Allows you to specify
custom text and title. When the link is complete, it can be used in
content pages and blocks.
Catalog Category Link Displays either an inline or block-style link to a selected catalog
category. When the link is complete, it can be used in content pages
and blocks.
Catalog New Products List Displays a block of products which have been designated as new, for
the duration of time specified in the product record.
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.
Dynamic Blocks Rotator Can be used to display a single dynamic block, or an assortment of
dynamic blocks in a series, random order, or shuffled. The dynamic
block can be triggered by a price rule, and placed on a specific page
and location, or configured to appear on all pages.
Gift Registry Search Gives shoppers the ability to search for public gift registries by name
or Registry ID.
Order by SKU Order by SKU can be displayed in the store as a convenience for all
shoppers, or made available only to those in specific customer
groups. Shoppers can either enter the SKU and quantity information
directly into the Order by SKU block, or upload a CSV file from their
customer account.
Widgets (cont.)
TYPE DESCRIPTION
Orders and Returns Gives guests the ability to check the status of their orders and submit
requests to return merchandise. The widget appears only for guests
and customers who are not logged in to their accounts.
Recently Compared Displays the block of recently compared products. You can specify
Products 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.
Wish List Search Gives customer the ability to search for publicly available wish lists
by the name or email address of the wish list owner. Store customers
can find wish lists that belong to other customers, view them and
order products from them, or add the products to their own wish lists.
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.
Widgets
Process Overview:
Step 1: Choose the Type
Step 2: Specify Where It Goes
Step 3: Complete the Options
Step 4: Check It Out!
1. On the Admin sidebar, tap Content. Then under Elements, choose Widgets.
a. In the Settings section, set Type to the type of widget that you want to create. ”Then, tap
Continue.
3. Tap Continue.
Widget Settings
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
3. In the Block Reference list, choose the area of the page layout where it is to be placed.
Layout Updates
Inline Template Formats the content so it can be placed inside other content. For
example, a link that goes inside a paragraph of text.
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.
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:
c. Set Condition to the category of products to be featured. The process is the same as
setting a condition for a price rule.
Widget Options
6. When prompted, follow the instructions at the top of the workspace to update the cache, as
needed.
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.
Process Overview:
Step 1: Set the Date Range for Each Product
Step 2: Create the Widget
Step 3: Choose the Location
Step 4: Configure the List
Step 5: Preview Your Work
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.
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.
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.
4. Tap Continue.
Widget Type
Widget Title Enter a descriptive title for your widget. This title is visible only
from the Admin.
Assign to Store Views Select the store views where the widget will be visible. You can
select a specific store view, or "All Store Views."
Sort Order (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.)
Storefront Properties
1. In the Layout Updates section, tap Add Layout Update. Then, do the following:
Layout Updates
For now, you can ignore the message to refresh the cache.
1. In the panel on the left, choose Widget Options. Then, do the following:
All Products Lists products in sequence, starting with those most recently
added.
New Products 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.
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.
Widget Options
5. When prompted to refresh the cache, click the link in the message at the top of the workspace,
and follow the instructions.
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.
l Email Address
l ZIP Code
2. Enter the Order ID and Billing Last Name. Then, enter either the billing Email Address or
ZIP Code that is associated with the order.
Order Information
1. On the Admin sidebar, tap Content. Then under Elements, choose Widgets.
4. Tap Continue.
Widget Title Enter a descriptive title for your widget. This title is visible only
from the Admin.
Assign to Store Views Select the store views where the widget will be available. You can
select a specific store view, or "All Store Views."
Sort Order (Optional) Enter a number to determine the relative order of this
item when it appears with other content in the same part of the
page. (0 = first, 1 = second, 3= third, and so on.)
6. In the Layout Updates section, tap Add Layout Update. Then, do the following:
b. Complete the rest of the layout update information to determine where the widget is to
appear on the page.
7. When complete, tap Save. Then when prompted, refresh each invalid cache.
l Tutorial 2: Blocks
Simple Page
l WYSIWYG Editor is enabled, and TinyMCE 4 is selected as the default in the WYSIWYG
Options configuration.
3. Do the following to download the image assets that are needed to complete the page.
a. Right-click the simple-page-assets.zip link, and save the file to your local computer.
b. Navigate to the file on your computer, and right-click to Extract All files. Then, choose the
destination folder, and tap Extract.
4. To complete parts 1, 2, and 3 of this tutorial, expand each section and follow the instructions.
In this part of the Simple Page tutorial, you will create a new page that has a full-bleed row
and banner. The row has different background images for desktop and mobile devices.
Overview
Step 1: Create a New Page
Step 2: Format the Row
Step 3: Add a Banner
1. On the Admin sidebar, choose Content. Then under Elements, choose Pages.
2. In the upper-right corner, tap Add New Page. Then, do the following:
a. To prevent this page from being published in your store, set Enable Page to “No.”
In addition to the five standard layout options, Page Builder adds full-width layouts for
pages, categories, and products.
b. If the sample data is available, set New Theme to “Magento Luma.” Otherwise, you can
either choose another available theme. or leave it blank to use the default theme.
The New Theme setting can be used to override the default theme, and to apply a different
theme to the page.
The Full Width layout can be used only with a compatible theme.
Design Section
When the page is saved, the name “Simple Page” appears in the upper-left corner.
1. Expand the Content section, and take note of the following workspace features:
l Stage with empty row where you can drag content types or columns
The Content Heading field is optional. It is by default, formatted as a heading level 1 (H1)
according to the theme. For the purpose of this tutorial, the Content Heading field is left blank.
2. Hover over the empty row to make the toolbox appear. Each content container has a toolbox
with a similar set of options.
Row Toolbox
3. In the Row toolbox, choose Settings ( ). Then under Appearance, choose “Full Bleed.”
The “Full Bleed” Appearance setting extends the left and right borders of the content area of
the row and background to the full width of the page.
Full Bleed
4. Scroll down to the Advanced section. Then, set all Margins and Padding settings to zero ( 0 ).
This setting ensures that the banner extends the full width of the row.
5. Scroll up to the top of the page. In the upper-right corner, Save the settings and return to the
Page Builder workspace. Then in the upper-right corner, tap Save to continue.
Page Builder has a new content type called “Banner,” which is featured in this step. What was
previously the “Banner” option in the Content menu is now “Dynamic Block.”
1. Expand the Content section. Then in the Page Builder panel on the left, expand the Media
section.
The stage now has two content containers, each with a separate toolbox. Because the banner is
nested inside the row, make sure that you are working in the correct toolbox.
In addition to the toolbox, the Upload Image and Select from Gallery buttons are included so
you can make quick changes to the banner directly from the stage.
Banner Toolbox
4. In the Banner toolbox, choose Settings ( ). Then, complete the following:
Appearance
The Collage Right setting positions content on the right side of the banner.
Collage Right
Background Image
c. Navigate to the directory on your computer where you saved the simple page assets.
Then, choose the file, wide-banner-background.jpg.
d. At the Background Mobile Image field, tap Upload. Then, choose the file, wide-banner-
background-mobile.jpg.
The mobile background image is used for mobile devices, and also whenever a desktop
browser window is resized to the width of a mobile device.
e. Scroll up to the top of the page. Then in the upper-right corner, Save the settings and
return to the Page Builder workspace.
The background appears on the stage, and extends the full width of the row.
Banner Content
Notice the placeholder text that appears on the right side of the row. The position of this text
reflects the “Collage Right” Appearance setting.
The editor toolbar appears above the text box. Text can be entered and formatted either
directly from the stage, or by choosing Settings from the banner toolbox.
b. Select the first line of text. Then on the editor toolbar under Formats, choose “Heading 2.”
Apply Format
c. Select the second line of text. Then on the editor toolbar under Formats, choose
“Paragraph.”
The format settings apply the styles from the style sheet that is associated with the
current theme.
d. Hover over the banner container. Then in the toolbox, choose Settings ( ).
Text can be entered and edited either from the stage, or from the Content section of
Banner Settings.
Message Text
a. Continuing in the Content section, find the Link field below the banner message.
b. To link the banner to the appropriate category of products, set Link to “Category.” Then,
click Select to show the category tree, and choose “What’s New.”
Link to Category
d. In the Button Text field, enter “Shop Now” as the text that appears on the button.
The button style from the current theme determines the button format.
Banner Overlay
You can use an overlay to apply a background color to the active content area that is defined
by the Appearance setting. The banner background image continues to be visible for the full
width of the banner.
l In the No Color field, either enter “White” or the hexadecimal value #ffffff.
Overlay Color
d. In the upper-right corner, Save the settings and return to the Page Builder workspace.
Fullscreen mode includes the Page Builder panel and the stage, and shows how the page looks
from the storefront.
6. To return to the Content section of the page, click Close ( ) in the upper-right corner of the
stage. You can toggle between the two workspace modes any time you want.
Fullscreen Mode
7. On the Save menu in the upper-right corner, choose Save & Close.
Save Menu
8. When prompted, click the Cache Management link in the message at the top of the page. Then
refresh any invalid cache.
Congratulations!
You have completed Part 1 of the Simple Page tutorial. Keep the work that you created, so you
can refer to it later.
In this part of the tutorial, you will add a new row to the page, and divide the row into two
equal columns. Then, you will add a linked image to each column. In the instructions, each
new row is added before the first row to make the Page Builder panel line up with the stage. At
the end of the tutorial, you will rearrange the rows so they match the Simple Page example.
Overview
Step 1: Add a New Row
Step 2: Add a Column
Step 3: Add Images
1. In the Pages grid, find the Simple Page that you created in the first part of this tutorial. Then
in the Action column, select Edit.
a. If necessary, scroll down so you can see the Page Builder panel and stage.
b. In the Page Builder panel under Layout, drag a Row placeholder to the stage, and place it
above the banner.
The red guideline marks the boundary between the two rows.
3. Hover over the new row. Then in the toolbox, choose Settings ( ).
Row Toolbox
The “Contained” Appearance setting limits the content area of the row to the width of the page
as defined by the theme.
Appearance “Contained”
5. In the upper-right corner, Save the settings and return to the Page Builder workspace.
1. In the Page Builder panel under Layout, drag a Column placeholder to the new row.
2. In the upper-left corner of the first column, click the circular Grid control ( ) to show the
grid guidelines.
The grid ensures that content is aligned consistently, and renders correctly on both desktop
and mobile devices. To learn more, see the Advanced Content Tools section of the Page Builder
configuration.
The numbers in parentheses (6 /12) in the top border of each column container indicate the
number of grid divisions in each column, and the total number of divisions in the row.
Grid Size
1. In this step, you will learn two ways to upload an image to the banner.
a. On the Page Builder panel, expand the Media section. Then, drag an Image placeholder
to the first column.
Upload Image
c. In the directory on your computer where you saved the simple page assets, choose the
file, small-banner-1.jpg.
a. In the Page Builder panel under Media, drag an Image placeholder to the second column.
b. On your desktop, open the simple page assets folder, and position it alongside the
Magento Admin window where you are working.
c. Drag the file small-banner-2.jpg from the simple page assets folder, and drop it in the
second column.
b. Hover over the image in the first column. Then in the toolbox, choose Settings ( ).
Image Toolbox
b. In the category tree, drill down and choose the “Men’s Hoodies & Sweatshirt” category.
c. In the upper-right corner, Save the settings and return to the Page Builder workspace.
4. Repeat these steps to link the image in the second column to the “Gear” category.
5. In the upper-right corner on the Save menu, choose Save & Close.
Save Menu
6. When prompted, click the Cache Management link in the message at the top of the page. Then
refresh any invalid cache.
Congratulations!
You have completed Part 2 of the Simple Page tutorial. Keep the work that you created, so you
can refer to it later.
The final row on this page features content from a product review. You will add a full-width
row, and divide it into two columns of different widths. A background image is added to the
first column, with a matching background color that is applied to the row for a unified effect.
Overview
Step 1: Add a New Row
Step 2: Add Columns of Different Widths
Step 3: Add an Image to the First Column
Step 4: Add Review Content to the Second Column
Step 5: Insert a Catalog Product Link
Step 6: Rearrange the Rows
1. On the Admin sidebar, choose Content. Then under Elements, choose Pages.
2. In the Pages grid, find the Simple Page that you created in the first part of this tutorial. Then
in the Action column, select Edit.
3. Expand the Content section, and scroll down to the Page Builder workspace.
4. In the Page Builder panel under Layout, drag a Row placeholder to the stage, and place it
above the row that was created in the second part of this tutorial.
5. Hover over the new row. Then in the toolbox, choose Settings ( ), and do the following:
Row Toolbox
The “Full Width” Appearance setting limits the content area to the maximum page width
that is defined by the theme. The background color and/or image are not limited, and
extend the full width of the row.
b. In the Background section, enter the following hexadecimal Background Color: #f1f1f1.
You can type right over the words, “No Color.”
Background Color
c. Scroll down to the Advanced section. Then, set all Margins & Padding values to zero
( 0 ).
6. Scroll up to the top of the page. Then, Save the settings and return to the Page Builder
workspace.
1. In the Page Builder panel under Layout, drag a Column placeholder to the stage.
2. Drag the right border of the first column to the “four of twelve” (4/12) position on the grid. The
size of the second column adjusts to “eight of twelve” (8/12).
3. Hover over first column container. Then in the toolbox, choose Settings ( ), and do the
following:
c. Scroll up to the top of the page. Then, Save the settings and return to the Page Builder
workspace.
1. In the Page Builder panel under Media, drag an Image content type to the first column. Then,
do the following:
Upload Image
b. In the directory on your computer where you saved the simple page assets, choose
review-image.jpg.
Uploaded Image
The second column of the row will contain content from a customer review, including the five-
star rating image and formatted text message.
1. If necessary, expand the Content section. Then, scroll down to the Page Builder workspace.
2. In the Page Builder panel, expand the Elements section. Then, drag the Text content type to
the second column.
3. In the editor toolbar, click Insert Image ( ). Then, do the following:
Insert Image
a. In the Insert/edit image box, just after the Source field, click Find ( ).
Insert/Edit Image
Upload Images
c. In the folder where you saved the simple page assets, choose rating.png. Then in the
gallery, double-click the image tile to insert its URL into the Source field.
d. In the Image Description field, enter “5-Star Rating.” Then, tap OK to insert the image
into the column.
e. In the editor toolbar, click Align Center ( ) to center the image in the column.
Centered Image
4. Position the insertion point just after the 5-star image, and press the Enter key to start a new
line. Then, enter the following text. The text is centered as you type.
Awesome Tank!
I’m a long distance runner and it keeps me pretty comfortable, although these
companies always act like their shirts are magical and really it’s just pretty
basic stuff. Still it’s a great shirt and I would recommend it.
Review Text
a. Click anywhere in the first line of text. Then on the editor toolbar under Formats, choose
“Heading 2.”
b. Select the remaining text. Then on the editor toolbar under Formats, choose “Paragraph.”
The text is formatted according to the style sheet that is associated with the theme.
6. To center the content vertically in the column, you must first know the height of the image. To
get the dimensions of the image, do the following:
a. Hover over the image in the first column. Then in the toolbox, choose Settings ( ).
b. Below the thumbnail of the image, take note of the dimensions of the image. Then in the
upper-right corner, tap Close.
Image Dimensions
a. Hover over the second column. Then in the toolbox, choose Settings ( ), and scroll
down to the Layout section.
Make sure to select the Column container rather than the Text container.
b. In the Minimum Height field, enter “450” as the height in pixels, of the image in the first
column.
Vertical Alignment
8. Scroll down to the Advanced section. Then, set all Margins and Padding values to zero ( 0 ).
9. Scroll up to the top of the page. Then in the upper-right corner, Save the settings and return to
the Page Builder workspace.
1. Select the text, “Antonia Racer Tank.” In the editor toolbar, click Insert Link ( ). Then, do
the following:
You can enter either a relative or fully-qualified URL. The following relative link is entered
for this example: ../antonia-racer-tank.html
c. When complete, tap OK to save the link and return to the Page Builder workspace.
Insert Link
The linked text is now highlighted in the banner.
With all three rows complete, the final step is to rearrange the rows to match the original
Simple Page example. To match the original example, the first row must be moved to the
bottom, and the last row must be moved to the top.
1. Hover over the first row on the stage. Then in the toolbox, choose Move ( ).
Move
2. Hold down the mouse button and verify that all content in the row is selected. Then, drag the
row into position below the red guideline at the bottom of the page.
If you accidentally move only part of the content — such as the image — simply move the content
back where it belongs, and try again.
Moving a Row
3. Repeat this process to move the first row to the second position.
The order of the rows on your page now matches the Simple Page example.
4. If you are working in Fullscreen mode, click Close ( ) in the upper-right corner to return to
the Page Builder workspace. Then on the Save menu, choose Save & Close.
Congratulations!
You have completed Part 3 of the Simple Page tutorial. Keep the work that you created, so you
can refer to it later.
Tutorial 2: Blocks
The following tutorial illustrates the difference between simple blocks and dynamic blocks, and
how to use Page Builder to create each type of block.
Regarding recent interface and terminology changes: What was previously the “Banner” option in
the Content menu is now “Dynamic Block.” In addition, Page Builder has a new content type called
“Banner,” which is featured in the first tutorial and is unrelated to the previous banner functionality.
l WYSIWYG Editor is enabled, and TinyMCE 4 is selected as the default in the WYSIWYG
Options configuration.
3. Do the following to download the image assets that are needed to complete the examples.
a. Right-click the simple-page-assenting link, and save the file to your local computer.
b. Navigate to the file on your computer, and right-click to Extract All files. Then, choose the
destination folder, and tap Extract.
4. To complete parts 1, 2, and 3 of this tutorial, expand each section and follow the instructions.
Overview
Step 1: Create a New Block
Step 2: Add a Google Map
Step 3: Configure Google Maps
Step 4: Add the Block to a Page
1. On the Admin sidebar, choose Content. Then under Elements, choose Blocks.
2. In the upper-right corner, tap Add New Block. Then, do the following:
Block Information
d. In the upper-right corner, Save the settings and return to the Page Builder workspace.
2. In the Page Builder panel, expand the Media section. Then, drag a Map placeholder to the
stage.
3. A map to your store location appears if Google Maps is configured for your store.
Google Maps
A placeholder map appears if Google Maps isn’t yet configured for your store.
4. In the upper-left corner on the Save menu, choose Save & Close.
1. In the Admin sidebar, choose Stores. Then under Settings, choose Configuration.
2. In the panel on the left under General, choose Content Management. Scroll down to the
Advanced Content Tools section. Then, complete the applicable instructions:
l If there is a problem with your key, return to the Google Maps site to resolve the
problem. Then, try again.
To set up a Google Maps key, you must be a site administrator with authority to enable billing
for your account. If you’re not ready to set up a Google Maps account at this time, you can
skip this step and use the Google Maps placeholder for now.
b. Follow the instructions to configure your Google Maps account and billing.
c. Copy your API Key. Then, complete the previous instructions to enter and test your key.
1. On the Admin sidebar, choose Content. Then under Elements, choose Pages.
2. In the grid, find the Simple Page that you created in the first tutorial. Then in the Action
column, select Edit.
3. Expand the Content section, and scroll down to the Page Builder workspace.
4. In the Page Builder panel under Layout, drag a row placeholder to the top of the stage.
d. In the Page Builder panel, expand the Add Content section. Then, drag a Block
placeholder to the new row.
5. Hover over the empty block container. Then in the toolbox, choose Settings ( ), and do the
following:
Block Toolbox
Select Block
b. In the search box, enter “map” and press the Enter key to find the block that you created.
c. In the grid, tap Select to choose the Google Maps block. Then in the upper-right corner,
tap Add Selected.
d. In the upper-right corner, Save the settings and return to the Page Builder workspace.
6. In the upper-right corner on the Save menu, choose Save & Close.
Save Menu
Congratulations!
You have completed the Part 1 of the Block tutorial. Make sure to keep your work for reference.
A dynamic block includes logic that determines where, when, and to whom it appears. In this
tutorial, you will create a dynamic block for a promotion that is triggered when price rule
conditions are met, and that appears only to a specific customer segment. The end result of
this example is similar to the banner that was created in the first tutorial, but with logic that
controls when it appears in the storefront.
Overview
Step 1: Create a Dynamic Block
Step 2: Complete the Settings
1. On the Admin sidebar, choose Content. Under Elements, choose Dynamic Blocks.
Dynamic Blocks
2. In the upper-right corner, tap Add Dynamic Block. Then, do the following:
The Dynamic Block Type determines where in the page layout the block is to be placed.
When setting up a dynamic block for your store, take into consideration both the page
layout and the theme, so you can put the available space to good use. Some stores have an
active content area that limited to a fixed width, while others extend the full width of the
screen.
d. In the Customer Segment list, mark the checkbox of each segment that you want to
apply to the dynamic block. Then, tap Done to save the setting.
For this example, we created two customer segments that identify registered customers by
gender. This dynamic block appears only to registered female customers who are logged in
to their accounts while they shop in your store.
Add an Image
a. In the Page Builder panel under Media, drag an Image placeholder to the row. Tap Select
from Gallery, and choose the wide-banner-background.png image.
b. Hover over the row container. Then in the toolbox, choose Settings ( ), and scroll down
to the Layout section.
d. In the upper-right corner, Save the settings, and return to the Page Builder workspace.
2. In the upper-right corner of the Tee Shirt Promo page, tap Save.
Add Columns
In the Page Builder panel under Layout, drag a Column placeholder to the stage.
Add Text
a. In the Page Builder panel under Elements, drag a Text placeholder to the second column.
Enter Text
c. Select all three lines of text. Then on the toolbar, set Line Height to "40px."
Line Height
Line 1: 28px
Line 2: 24px
Line 3: 18px
Because this block could be placed anywhere on the page, we use the default paragraph
style, rather than heading levels. Also, don't worry that the text doesn't yet wrap correctly
in the column.
Formatted Text
Add a Link
In the first tutorial, you learned how to use the Button content type to create a link. This
example shows how to insert a link from the editor toolbar.
a. In the storefront, navigate to the page that is to be the target destination for the link. You
can either paste the fully qualified URL, or a relative URL that omits the reference to your
store domain.
b. In the text editor, select the "Shop Tees >" text in the third line. Then, on the editor
toolbar, choose Bold ( ).
c. Again select the "Shop Tees >" text in the third line. Then, on the editor toolbar, choose
Insert/edit link ( ).
Formatted Text
This setting opens the page in the same browser window, rather than opening a new tab.
g. Tap OK to save the link, and return to the Page Builder workspace.
Link Detail
1. Expand the Related Promotions section of the New Dynamic Block page. Tap Add Cart Price
Rules, and do the following:
Related Promotions
2. On the Add Related Cart Price Rules page, mark the checkbox for the "Buy 3 tee shirts and get
the 4th fee" price rule. Then, tap Add Selected.
Congratulations!
You have completed the Part 2 of the Block tutorial. Keep the dynamic block that you created,
so you can use it for reference.
1. In the Admin sidebar, choose Content. Then under Elements, choose Pages
2. Open the Simple Page that you created in the first tutorial in edit mode. Then expand the
Content section and do the following:
a. In the Page Builder panel, expand the Layout section. Then, drag a Row placeholder to
the top of the stage.
b. In the Page Builder panel, expand the Add Content section. Then, drag a Dynamic Block
placeholder to the new row.
c. Hover over the dynamic block container. Then in the toolbox, choose Settings ( ).
e. On the Select Dynamic Block page, find the “Tee Shirt Promo” dynamic block that you
created, and tap Select. Then, tap Add Selected.
g. When complete, Save the settings and return to the Page Builder workspace.
Congratulations!
You have completed the Part 2 of the Block tutorial. Make sure to keep your work for reference.
Overview
Step 1: Edit the Dynamic Block
Step 2: View the Dynamic Block
1. In the Admin sidebar, choose Content. Then under Elements, choose Dynamic Blocks
2. Find the Tee Shirt Promo in the Dynamic Blocks grid. Click anywhere on the row to open the
block in edit mode. Then, expand the Content section.
b. Hold down the mouse button, and drag the border two divisions to the left.
Grid Divisions
The first column is now four of twelve (4/12) grid divisions wide, and the second column is
eight of twelve (8/12) divisions wide.
b. On the Editor toolbar, choose Text Color. Then, click the White swatch.
Text Color
5. On the Save menu in the upper-right corner, choose Save & Close.
2. To view your sample page, modify the URL in the address bar as follows:
mystore.com/sample-page
If your store is configured to include the html suffix, include the suffix as follows:
mystore.com/sample-page.html
b. If the sample data is installed on your system, use the following credentials:
Email [email protected]
Password [email protected]
d. Return to the sample page to see the dynamic block that you created with the Tee Shirt
Promo.
Congratulations!
You have completed the Part 3 of the Block tutorial. Make sure to keep your work for reference.
Product List
Page Builder makes it easy to add a product list to the stage. In this example, the product list
is added directly to a page.
Overview
Step 1: Add a Product List
Step 2: Compose the Condition
Step 3: Complete the Settings
2. Open the Simple Page that you created in the first tutorial. Then, scroll down and expand the
Content section.
Content Stage
3. In the Page Builder panel under Layout, drag a Row to the top of the stage.
4. In the Page Builder panel under Add Content, drag a Products placeholder to the new row.
1. Hover over the empty products container. Then in the toolbox, choose Settings ( ), and do
the following:
Products Toolbox
a. On the Edit Products page under Condition, click Add ( ). Then under Product
Attribute, choose Category.
Condition
b. To complete the “Category is ...” part of the condition, click More (...). Then after the field,
click the Chooser ( ).
Condition
c. In the category tree, drill down to the Women > Tops category, and mark the Tees
checkbox.
Category Tree
Product List
2. Complete the remaining settings as needed, using the field descriptions at the end of the Add
Products topic for reference.
3. When complete, Save the settings and return to the Page Builder workspace.
4. In the upper-right corner on the Save menu, tap Save & Close.
In this tutorial, you will learn how easy it is to customize a product page by placing a video
below the set of tabs on the product page. The process to update category page content is
basically the same.
2. Open a simple product that you can use for this example.
3. Scroll down, and expand the Content section. Then, at the Description label, tap Edit with
Page Builder.
Content Section
If the product description was entered previously without Page Builder, the current
description appears as HTML in an HTML Code container. With the Luma theme, the
product description appears on the Detail tab.
d. In the Page Builder panel under Layout, drag a Row to the stage, placing it below the
HTML Code container. Look for the red guideline to appear when the row is in the correct
position.
4. In the Page Builder panel, under Media, drag a Video placeholder to the new row. Then, do the
following:
Video
5. Hover over the empty video container. Then in the toolbox, choose Settings ( ), and do the
following:
Video Toolbox
The video can be hosted on either YouTube or Vimeo. The video in this example can be
found on YouTube at the following URL:
https://www.youtube.com/watch?v=ZpFrNyD4100
Edit Video
If you leave the Maximum Width blank, the video will fill the available space.
Edit Video
c. In the upper-right corner of the workspace, click the Fullscreen ( ) icon to return to the
Content section of the product.
d. In the upper-right corner on the Save menu, choose Save & Close.
In the storefront, the video appears below the set of tabs. To see how the page look on a mobile
device, resize the window.
Congratulations!
You have completed Part 2 of the Catalog Content tutorial. Keep the work that you created, so
you can refer to it later.
Overview
Before you begin
Step 1: Create Custom Attributes
Step 2: Update the Product Attribute Set
Step 3: Update the Product
Step 4: Check It Out!
2. In the upper-right corner, tap Add Product. Then, complete the following properties:
SKU: Tutorial
Price: 75.00
Quantity: 100
Weight: 1
1. On the Admin sidebar, choose Stores. Then under Attributes, choose Product.
2. In the upper-right corner, tap Add New Attribute. Then, do the following:
For this example, we use the label, "My Page Builder Attribute."
When creating a custom attribute, you can specify the editor that is most suitable to the
application as either "Page Builder" or the standard, WYSIWYG "Text Editor."
Unique Value: No
Add to Column No
Options:
d. In the Attribute Information panel, choose Storefront Properties. Then, make the
following settings:
3. Repeat these steps to create a second attribute with the same basic properties, but with the
Text Editor input type as follows:
1. On the Admin sidebar, choose Stores. Then under Attributes, choose Attribute Set.
For the purpose of this example, we'll temporarily add the new attributes to the default
attribute set. At the end of this tutorial, remove the attributes from the attribute set, so they
won't impact your catalog.
If you don't want to make changes to your live store, you can follow along without updating the
attribute set.
2. Find the default attribute set in the grid, and open in edit mode. Then, do the following:
The location of the attribute in the Groups column determines where it appears on the
page.
3. When prompted, click the Cache Management link at the top of the page. Then, refresh any
invalid cache.
The full-featured Page Builder workspace is available for both the Product Description and
Page Builder Attribute field. Both the Short Description and Text Editor Attribute fields use
the standard WYSIWYG editor. To learn more, see: Product Attributes.
4. At the product Description field, tap Edit with Page Builder. Then, do the following:
a. In the Page Builder panel under Elements, drag a Text object to the stage. Then, enter
"Page Builder attribute placeholder text."
c. In the Text Editor Attribute editor, enter "Text Editor Attribute placeholder text."
d. In the upper-right corner on the Save menu, choose Save & Close.
e. At the My Page Builder Attribute field, tap Edit with Page Builder.
5. If prompted, click the Cache Management link in the message at the top of the page. Then,
refresh any invalid cache.
In this example, the product can be found in the top navigation under Women > Tops > Tees.
The position of the attributes on the product page is determined by the theme. In the Luma
theme, the new attributes are located just after the Description field.
Congratulations!
You have completed Part 3 of the Catalog Content tutorial. Keep the work that you created, so
you can refer to it later.
1. On the Admin sidebar, choose Stores. Then under Settings, choose Configuration.
3. Under Advanced Content Tools, verify that Enable Page Builder is set to "Yes."
a. If necessary, follow the Get API Key instructions. Then, paste your Google Maps API Key.
b. To change the Google Maps Style, paste the JSON code that is generated by the Google
Maps APIs Styling Wizard.
a. In the Default Column Grid Size field, enter the default number of columns that you want
to appear in the grid.
b. In the Maximum Column Grid Size field, enter the largest number of columns that you
want to be available in the grid.
1. On the Admin sidebar, choose Stores. Then under Settings, choose Configuration.
Default Layouts
a. Choose the Default Product Layout that you want to use for product pages.
b. Choose the Default Category Layout that you want to use for category pages.
c. Choose the Default Page Layout that you want to use for CMS pages.
Disabling Page Builder replaces the Advanced Content Tools with the WYSIWYG editor, and might
cause display errors in the storefront. Content that you created previously with Page Builder might
no longer be editable from the Admin.
1. On the Admin sidebar, choose Stores. Then under Settings, choose Configuration.
3. Under Advanced Content Tools, verify that Enable Page Builder is set to "Yes." Then when
prompted to confirm, tap OK.
4. When complete, tap Save Config.Then when prompted, refresh any invalid cache.
Workspace
When Page Builder is enabled, the Content section and content creation process are modified to
take advantage of Page Builder’s advanced tools. The new content section includes a Content
Heading field, the stage with an initial row and toolbox, and Page Builder panel with drag and
drop content types.
Content Heading
Because search engines look for level one (H1) headings, adding a level one heading is an easy
way to ensure that the page is indexed correctly.
The Content Heading field that appears at the top of the page is a legacy field that supports
content that was created with earlier versions of Magento. It is not, however, part of Page
Builder. The Content Heading is formatted as an H1 heading according to the style sheet that
is associated with the current theme, and positioned just above the active content area that is
defined by the Page Builder stage.
For the best control over the positioning and format of headings of all levels, we recommend
that you leave the Content Heading field blank, and use the Page Builder Heading content
type.
Stage
The stage is the primary work area where you can create and format content, and even make
quick edits to live content. The stage initially contains a single row. Additional rows can be
dragged to the stage from the panel on the left.
Panel
The Page Builder panel is located to the left of the stage, and contains content types that can
be dragged to the stage. A container that is specific to the content type then appears with a
toolbox of options. Content types are organized in the panel as follows:
Layout Includes rows, columns, and tabs that can be used as containers
for other content types.
Media Includes images, video, banners, sliders, and Google Maps that
can be dragged to the stage.
Add Content Adds existing blocks of static or dynamic content, and products
from your catalog.
Toolbox
Each content container on the stage has a toolbox of options. The options vary by content type,
but typically include Move, Settings, Hide/Show, Duplicate, and Remove.
Toolbox Options
OPTION ICON DESCRIPTION
Move Moves the current content container to another
position on the stage.
Layout
The Layout section of the Page Builder panel is used to add rows, columns, or tabs to the stage.
When a content type is dragged from the panel to the stage, a container appears with a toolbox
of options that are specific to the content type.
By default, the Page Builder stage has an initial row. Additional content types can be dragged
from the panel to the stage, and placed either inside the row, or positioned above or below the
row, according to type.
Column A column can be dragged from the panel to a row. The maximum
number of columns that can be added is determined by the number of
grid divisions that is specified in the configuration.
Tabs A single tab can be dragged from the panel to a row. Additional tabs
can be added from the toolbox.
Row
Use the Row content type to add a new row to the stage. The row is the basic building block of
all Page Builder content. Whenever you create new content, the stage is initially populated with
a single, blank row. The row toolbox appears when you hover over the container. The toolbox
includes options to move, hide, duplicate, edit, or remove the row. The selection of settings
determines the appearance, background and layout of the row. Additional content elements can
be dragged to the row from the Page Builder panel on the left.
Row Toolbox
To add a row:
1. In the Page Builder panel under Layout, drag a new Row to the stage, just below the first row.
2. To format the row, hover over the container. Then in the toolbox, choose Settings, and
complete the following as needed:
Appearance
The Appearance setting determines how the background color and/or background image
appears in relation to the container and width of the content area.
l Contained
l Full Width
l Full Bleed
Appearance
Background Color
l The rgba value for the color, with opacity percent, such as "rgba(255, 255, 255, 0.75)"
No Color
l In the color picker, drag the cursor to the color that you want.
Choose Swatch
2. Page Builder supports a transparency layer, or "alpha channel" that can be used to create
backgrounds with varying degrees of opacity. Do the following to set the opacity of the
background color:
The box below the slider shows the current red, green, blue, and alpha values (rgba). The
last number indicates the current opacity percentage as a decimal.
Set Opacity
Background Image
l Tap Upload. Then, navigate to the image on your local drive, and tap Open.
l Tap Select from Gallery. Then in the gallery, select the image that you want to use for
the row background, and tap Add Selected.
The image is added to the gallery, and the dimensions of the image appear below the
image in the Background section.
Background Image
b. To use a different background image for mobile devices, repeat these steps to specify the
Background Mobile Image that you want to use.
Cover The background image covers the full width of the row.
Contain The background image is limited to the width of the content area.
Background Size
b. To determine how the background image is anchored in relation to the row, set
Background Position to one of the following:
The anchor point is like a push pin that attaches the image to the row at the specified
background position.
c. The attached background image can be set to a fixed position, or to move as the page
scrolls. Set Background Attachment to one of the following:
l Scroll
d. To control the speed of a scrolling background image, expand the Parallax Background
section. Set Enable Parallax Background to "Yes." Then, enter the Parallax Speed as a
decimal value between -1.0 and 2.0.
e. To repeat the background image as a tiled background, set Background Repeat to "Yes."
Parallax Background
Layout
For example, you might set Minimum Height to match the height of a background image
to ensure that the full image is visible.
b. Choose one of the following Vertical Alignment settings to align any content containers
that are added to the row:
l Top
l Center
l Bottom
Layout Settings
Advanced
a. Set the horizontal Alignment of content containers that are added to the row to one of the
following:
l Default
l Left
l Center
l Right
b. Choose the Border style that you want to apply to all sides of the row container.
l Click the “No Color” swatch, and then choose a colored swatch.
l In the “No Color” field, enter a valid color name or hexadecimal value.
Border Color
e. For a border with curved corners, enter the Border Radius in pixels.
3. To preview how the content looks from the storefront, click the Full Screen icon ( ).
You can continue to work in full screen mode, or click Close ( X ) in the upper-right corner to
return to the workspace.
4. When complete, scroll up to the top of the page, and tap Save & Close to return to the Pages
grid.
Adding a Row
1. Hover over the row container. Then in the toolbox, choose Settings ( ).
2. Update the settings as needed, using the field descriptions at the end of this page for reference.
3. When complete, tap Save in the upper-right corner to close the Edit Row page. Then again in
the upper-right corner, tap Save.
Row Toolbox
TOOL ICON DESCRIPTION
Move Moves the row to another position in relation to other
rows on the stage.
Settings Opens the Edit Row page, where you can change the
properties of the container.
Remove Deletes the row and its content from the stage.
Row Settings
SETTING DESCRIPTION
Appearance Determines how the background color and/or image appears in
relation to the row container, and the width that is available for
content.
Center
Center Right
Bottom Left
Bottom Center
Bottom Right
ADVANCED
Border Determines the border style that is applied to all sides of the row
container. Options:
Border Color Determines the color of the container border. Specify the color by
choosing a swatch, clicking the color picker, or by entering a valid
color name or equivalent hexadecimal value.
Border Radius Specifies the size of the radius that is used to round each corner of
the container border.
CSS Classes Specifies the names of CSS classes from the current style sheet
which apply to the text container. Separate multiple class names with
a space.
Margins and Padding Determines the size, in pixels, of the outer margins and inner padding
of the row. Enter the corresponding values in the diagram. Options:
Column
Use the Column content type to divide a row into multiple columns. When a column is added
to an empty row, the row is initially divided into two columns of equal width. You can add
additional columns, or remove columns, as needed. A column can be resized by dragging the
border between two columns. The width of the next column is adjusted to fill the available
space in the row. If a row has only a single column, it extends the full width of the row.
Each column has a toolbox of options that appears when you hover over the container.
Adding a Column
The grid ensures that content is aligned consistently in a column, and helps the page render
correctly on both desktop and mobile devices. To learn more, see the Advanced Content Tools
section of the Page Builder configuration.
To add a column:
1. In the Page Builder panel under Layout, drag a Column to the row.
2. In the upper-left corner of the row, click the small, circular Grid control ( ).
Positioning content on the grid helps to align content consistently, and render the page
correctly on both desktop and mobile devices. To learn more, see the Advanced Content Tools
section of the Page Builder configuration.
To resize a column:
The border is highlighted, and the toolbox for the selected column appears.
2. Hold down the mouse button to show the grid. Then, drag the border to a new position on the
grid. The width of both columns adjusts to reflect the change.
The new width of each column appears after the label, as “4/12” (four out of twelve) and “8/12”
(eight out of twelve).
Resized Columns
To remove a column:
1. Hover over the column that you want to remove. Then in the toolbox, choose Remove ( ).
Toolbox
To speed up the process in the future, you can remove the confirmation step by marking the
Do not show this again checkbox.
The row now has a single column (12/12) and grid. Because the grid is available only for
columns, you can use this technique to show the grid for any row.
Hover over the column. Then in the toolbox, choose Settings ( ), and do the following:
Zero Padding
c. In the upper-right corner, tap Save to close the Edit Column page.
2. Update the settings as needed using the field descriptions at the end of this page for reference.
3. When complete, tap Save in the upper-right corner to close the Edit Column page. Then again
in the upper-right corner, tap Save.
Column Toolbox
TOOL ICON DESCRIPTION
Move Moves the column and its content to another position
in relation to other columns in the row.
(position / grid size) Specifies the grid guideline that determines the
column width, and the total number of guidelines in the
row. For example, "3/12" indicates that the column is
the width of three guidelines out of a total of of twelve
in the grid.
Settings Opens the Edit Column page, where you can change
the properties of the container.
Column Settings
SETTING DESCRIPTION
Appearance Determines the position of the column in relation to the row.
Full Height The column extends the full height of the row.
ADVANCED
Border Determines the border style that is applied to all sides of the column
container. Options:
Border Color Determines the color of the container border. Specify the color by
choosing a swatch, clicking the color picker, or by entering a valid
color name or equivalent hexadecimal value.
CSS Classes Specifies the names of CSS classes from the current style sheet
which apply to the column. Separate multiple class names with a
space.
Margins and Padding Determines the size, in pixels, of the outer margins and inner padding
of the column. Enter the corresponding values in the column
container diagram. Options:
Tabs
Use the Tabs content type to add a set of tabs to the stage. When the Tabs placeholder is
dragged from the panel to the stage, a single default tab initially appears. You can add more
tabs as needed to create a full set. The width of the tab set is determined by the width of its
parent container and padding settings.
Set of Tabs
1. In the Page Builder panel under Layout, drag the Tabs placeholder to a row or column on the
stage.
2. Click the “Tab 1” label. In the toolbox, choose Settings ( ). Then, do the following:
Tab 1 Toolbox
a. In the General section, enter the Tab Name that you want to use as a label.
Tab Name
b. In the Background section, choose a Background Color. For this example, we entered the
hexadecimal value #ffdd16.
c. Scroll down to the Advanced section, and make the following settings:
SETTING VALUE
Border: Solid
Border Width: 1 px
Border Radius: 20 px
d. Scroll up to the top of the page. Then in the upper-right corner, tap Save.
e. To add a tab with the same settings, return to the toolbox and choose Duplicate ( ).
Then, repeat this step to add a third tab.
f. To update the labels for the other tabs, select each label. Then, type the text that you want
to appear on the label.
Tab labels can be updated either directly from the stage, or by changing the Tab Name
setting.
3. To open the main Tabs toolbox, point to the center top of the stage, and move the pointer
down until the toolbox appears. Then, choose Settings ( ), and do the following:
b. In the upper-right corner, tap Save to return to the Page Builder workspace.
a. Click the first tab. Then in the Page Builder panel, drag a Text placeholder to the tab.
b. Type or paste some text in the editor. Then, use the editor toolbar to format it as needed.
Add Text
2. Change the settings as needed using the field descriptions at the end of this topic for reference.
3. When complete, tap Save in the upper-right corner to close the Edit Tab page. Then again in
the upper-right corner, tap Save.
1. Hover over the top border of the tab set container. Then in the toolbox, choose Settings ( ).
2. Update the settings as needed, using the field descriptions at the end of this page for reference.
3. When complete, tap Save in the upper-right corner to close the Edit Tabs page. Then again in
the upper-right corner, tap Save.
Settings Opens the Edit Tab page, where you can change the
properties of the container.
Settings Opens the Edit Tabs page, where you can change the
properties of the individual tab.
BACKGROUND
Background Color Determines the background color and opacity of the tab.
Background Image Determines the location of the background image, and applies the
image to the tab. Options:
Background Mobile Determines the location of the background image that is to be used for
Image mobile devices, and applies the image to the tab. If left blank, the
standard desktop background image is used. Options:
Background Size Determines how the background image is scaled in relation to the width
of the tab. Options:
Background Position Determines the anchor point of the image in relation to the tab. Options:
Top Left
Top Center
Top Right
Center Left
Center
Center Right
Bottom Left
Bottom Center
Bottom Right
Background Attachment Determines how the background image moves in relation to scrolling.
Options:
LAYOUT
Minimum Height Determines the minimum height of the tab. For example, you might set
the minimum height to match the height of a background image.
Vertical Alignment Determines the vertical position of content containers that are added to
the tab.
ADVANCED
Border Determines the border style that is applied to all sides of the tab.
Options:
Border Color Determines the color of the container border. You can specify the color
by choosing a swatch, clicking the color picker, or by entering a valid
color name or equivalent hexadecimal value.
Border Radius Specifies the size of the radius that rounds each corner of the border.
CSS Classes Specifies the names of CSS classes from the current style sheet
which are to be applied to the tabs. Separate multiple class names with
a space.
Margins and Padding Determines the size, in pixels, of the outer margins and inner padding
of the tab. Enter the corresponding values in the container diagram.
Options:
GENERAL
Default Active Tab Determines which tab is active when the page loads. Options: (All
current tabs by label.)
Minimum Height Specifies the minimum height of the tab set in pixels.
ADVANCED
Border Determines the border style that is applied to all sides of the tab.
Options:
Border Color Determines the color of the container border. Specify the color by
choosing a swatch, clicking the color picker, or by entering a valid
color name or equivalent hexadecimal value.
Border Radius Specifies the size of the radius that rounds each corner of the border.
CSS Classes Specifies the names of CSS classes from the current style sheet
which apply to the tabs. Separate multiple class names with a space.
Margins and Padding Determines the size, in pixels, of the outer margins and inner padding
of the tab. Enter the corresponding values in the container diagram.
Options:
Elements
Use the Elements section of the Page Builder panel to add text, headings, buttons, dividers,
and HTML code to any layout container on the stage. When you drag a content type from the
panel to either a row, column, or tab set on the stage, a container appears with a toolbox of
options specific to the content type.
Text
Use the Text content type to add a container and text editor with a “What You See Is What You
Get” view of the content to the stage. In addition, you can add links, images, variables, and
widgets to the text from the editor toolbar. You can access the text editor directly from the
stage or from the toolbox Settings. Changes made directly to the stage are saved automatically.
To learn more, see: Using the Editor.
To add text:
1. In the Page Builder panel under Elements, drag a Text placeholder to a row, column, or tab set
on the stage.
2. Use the editor to enter and format text, as needed. To learn more, see: Using the Editor.
To add a link:
The Insert Link button in the editor makes it easy to add a hyperlink to an image in the
gallery. However, it can also be used to create an inline link in text, provided that you have the
URL in advance. Unlike the Widget button, the Insert/Edit link button is not integrated with
pages, products, or categories in the store.
To create a link for a telephone number or email, see: Adding Custom Variables.
1. In the storefront, navigate to the page that is to be the target destination for the link. You can
either paste the fully qualified URL, or a relative URL that omits the reference to your store
domain.
2. In the text editor, select the "Shop Tees >" text in the third line. Then, on the editor toolbar,
choose Bold ( ).
3. Again select the "Shop Tees >" text in the third line. Then, on the editor toolbar, choose
Insert/edit link ( ).
Formatted Text
This setting opens the page in the same browser window, rather than opening a new tab.
7. Tap OK to save the link, and return to the Page Builder workspace.
Link Detail
1. Hover over the text container. Then in the toolbox, choose Settings ( ).
Because the text container is tightly nested inside another container, make sure that you have the
correct toolbox.
Text Toolbox
2. Update the content and settings as needed, using the field descriptions at the end of this page
for reference.
3. When complete, tap Save in the upper-right corner to save the settings, and return to the Page
Builder workspace. Then again in the upper-right corner, tap Save to save all changes to the
page.
Text Toolbox
TOOL ICON DESCRIPTION
Move Moves the text container to another place in a row,
column, or set of tabs.
Remove Deletes the text container and its contents from the
stage.
Text Settings
SETTING DESCRIPTION
Editor Used to enter new text or edit existing text. You can also enter and
edit text, and add links, images, variables, and widgets from the
editor toolbar.
ADVANCED
Border Determines the border style that is applied to all sides of the text
container. Options:
Border Color Determines the color of the container border. Specify the color by
choosing a swatch, clicking the color picker, or by entering a valid
color name or equivalent hexadecimal value.
Border Radius Specifies the size of the radius that is used to round each corner of
the container border.
CSS Classes Specifies the names of CSS classes from the current style sheet
which apply to the text. Separate multiple class names with a space.
Margins and Padding Determines the size, in pixels, of the outer margins and inner padding
of the text container. Enter the corresponding values in the visual
representation of the container. Options:
Heading
Heading levels establish a hierarchy that organizes content, and helps search engines index
each page. Use the Heading content type to add a text container with a heading level from H1
to H6 to the stage. Headings are formatted according to the style sheet that is associated with
the current theme.
The Content Heading field in the Content section can be used to add an H1 heading to the top
of the page. However, the field is a legacy from previous versions of Magento, and is provided
to support older content. Because this field does not take advantage of Page Builder’s advanced
features, we recommend that you leave the Content Heading field blank, and use the Page
Builder Heading content type to add headings of any level to the page. The following
screenshot shows how the Content Heading and the Heading content type appear when
formatted by the Luma theme.
To add a heading:
1. In the Page Builder panel, expand the Elements section. Then, drag a Heading placeholder to
a row, column, or tab set on the stage.
2. In the editor, type the heading text over the “Edit Heading Text” placeholder.
By default, the heading text is assigned a level two (H2) heading type.
1. Hover over the heading container. Then in the toolbox, choose Settings ( ).
Header Toolbox
2. Update the settings as needed, using the field descriptions at the end of this page for reference.
3. When complete, Save the settings and return to the Page Builder workspace. Then to save the
page, tap Save.
To duplicate a heading:
For a formatted heading with specific settings, it is more efficient to duplicate the heading,
rather than start over with a new placeholder.
1. Hover over the heading container. Then in the toolbox, choose Duplicate ( ).
Duplicate Heading
2. To move the new heading, hover over the container. Then in the toolbox, choose Move ( ).
Move Heading
3. Hold down the mouse button, and drag the heading until the red guideline marks the new
position.
The top and bottom borders of each container appear as dashed lines while the heading is
being moved.
4. If you need to change the heading level, click the heading text. Then in the toolbar, choose the
new level.
Heading Toolbox
TOOL ICON DESCRIPTION
Move Moves the heading container to another valid place on
the stage.
Settings Opens the Edit Heading page, where you can change
the properties of the container.
Remove Deletes the heading container and its content from the
stage.
Heading Settings
SETTING DESCRIPTION
Heading Type Assigns a heading level between H1 - H6, and formats the text
according to the style sheet that is associated with the current
theme. Options:
ADVANCED
Border Determines the border style that is applied to all four sides of the
heading container. Options:
Border Color Determines the color of the container border. Specify the color by
choosing a swatch, clicking the color picker, or by entering a valid
color name or equivalent hexadecimal value.
Border Radius Specifies the size of the radius that is used to round each corner of
the border.
CSS Classes Specifies the names of CSS classes from the current style sheet
which apply to the heading. Separate multiple class names with a
space.
Margins and Padding Determines the size, in pixels, of the outer margins and inner padding
of the heading container. Enter the corresponding values in the
diagram. Options:
Divider
Use the Divider content type to add a rule as a visual break between sections of content on the
stage. You can specify the line color, thickness, and width of the divider, as well as control the
alignment, margins and padding, and format of the container border. By default, the divider is
a hairline rule that extends the full width of the container, with allowance for padding.
To add a divider:
1. In the Page Builder panel under Elements, drag a Divider placeholder to a row, column, or tab
set on the stage.
2. Use the red guideline for reference as you position the divider either before or after another
content container on the stage.
In the following example, the divider marks the beginning of a new section of text.
1. Hover over the container. Then in the toolbox, choose Settings ( ), and do the following:
Line Color
d. Enter the Line Width followed by either “px” or “%” to indicate the unit of measurement.
Center Alignment
f. Update the remaining settings as needed, using the field descriptions at the end of this
page for reference.
g. When complete, Save the settings and return to the Page Builder workspace.
To duplicate a divider:
For a formatted divider with specific settings, it is more efficient to make a duplicate, rather
than start over with a new placeholder.
Duplicate Divider
2. To move the new divider into position, hover over the container. Then in the toolbox, choose
Move ( ).
Move Divider
3. Hold down the mouse button, and drag the divider until the red guideline marks the new
position.
The top and bottom borders of each container appear as dashed lines while the divider is being
moved.
Divider Toolbox
TOOL ICON DESCRIPTION
Move Moves the divider container to another valid place on
the page.
Settings Opens the Edit Divider page, where you can change
the properties of the divider and its container.
Remove Deletes the divider container and its content from the
stage.
Divider Settings
SETTING DESCRIPTION
Line Color Determines the color of the divider.
ADVANCED
Border Determines the border style that is applied to all sides of the divider
container. Options:
Border Color Determines the color of the container border. Specify the color by
choosing a swatch, clicking the color picker, or by entering a valid
color name or equivalent hexadecimal value.
Border Radius Specifies the size of the radius that is used to round each corner of
the container border.
CSS Classes Specifies the names of CSS classes from the current style sheet
which apply to the divider. Separate multiple class names with a
space.
Margins and Padding Determines the size, in pixels, of the outer margins and inner padding
of the row. Enter each corresponding value in the row container
diagram. Options:
Buttons
Use the Buttons content type to add either an individual button, or a set of buttons to the
stage. Buttons can be arranged horizontally or vertically, and added directly to rows, columns,
tabs, and banners on the stage.
1. In the Page Builder panel under Elements, drag a Buttons placeholder to a row, column, or
tab set on the stage.
2. If necessary, hover over the container to make the toolbox appear. Then, choose Settings ( ).
Button Toolbox
Button Text
Primary Applies the primary button style from the current style sheet.
Secondary Applies the secondary button style from the current style sheet if
applicable.
URL
The URL can be either a relative link to a product or page in your store, or a fully-qualified
URL.
Fully-qualified http://mystore.com/luma-analog-watch.html
URL
c. If the link goes to a different website, you can keep the current page open to your store by
opening the link in a new browser tab.
To prevent the visitor from navigating away from your store, mark the Open in new tab
checkbox.
Product
Category
l Click the blank Select field, and find the category in the tree.
Page
l Click the blank Select field, and find the page in the list.
6. Complete the remaining settings as needed, using the field descriptions at the end of this topic
for reference.
7. When complete, tap Save in the upper-right corner to close the Edit Button page. Then again
in the upper-right corner, tap Save.
Add Button
3. Type the text that you want to appear on the second button.
4. Click the new button to display its toolbox. Then, choose Settings ( ), and do the following:
Add Button
In this example, the link is a relative URL that goes to the Contact Us page.
c. Update the remaining settings as needed, using the field descriptions at the end of this
topic for reference.
5. Click the second button again. Then in its toolbox, choose Duplicate ( ).
Duplicate Button
6. Type the text that you want to appear on the third button.
7. Click the third button. In its toolbox, choose Settings ( ). Then, do the following:
b. In the upper-right corner, tap Save to close the Edit Button page and return to the Page
Builder workspace.
8. This time, hover over the container. In the toolbox, choose Settings ( ). Then, do the
following:
Buttons Toolbox
a. Under Appearance, choose “Stacked.” Then, set All Buttons are same size to “Yes.”
b. Update the remaining settings as needed, using the field descriptions at the end of this
page for reference.
c. When complete, tap Save to close the Edit Buttons page, and return to the Page Builder
workspace.
The complete stacked button set appears on the stage, with one primary button and two
secondary buttons.
To move buttons:
2. On the Move ( ) icon, hold down the mouse button, and drag the button to a new position
in the button set.
Moving a Button
Button Toolboxes
3. Update the settings as needed, using the field descriptions at the bottom of this page for
reference.
4. In the upper-right corner, Save the settings and return to the Page Builder workspace.
Settings Opens the Edit Buttons page, where you can change
the properties of the container.
Remove Deletes the button container and its content from the
stage.
Button Settings
SETTING DESCRIPTION
Button Text The text on the button can be updated directly from the stage, or from
the Edit Button page.
Button Link Determines the destination page that is served when the button is
clicked. Options:
All buttons are same size When the checkbox is marked, all buttons in the container have a
consistent size, based on the length of the longest button text.
Options: Yes / No
ADVANCED
Border Determines the border style that is applied to all four sides of the
button container. Options:
Border Color Determines the color of the container border. You can specify the
color by choosing a swatch, clicking the color picker, or by entering a
valid color name or equivalent hexadecimal value.
Border Radius Specifies the size of the radius that is used to round each corner of
the container border.
CSS Classes Specifies the names of CSS classes from the current style sheet
which apply to the buttons. Separate multiple class names with a
space.
Margins and Padding Determines the size, in pixels, of the outer margins and inner padding
of the button container. Enter the corresponding values in the visual
representation of the container. Options:
HTML Code
Use the HTML Code content type to add snippets of HTML, CSS, and JavaScript code to the
stage. For example, you might want to add custom HTML, declare a CSS class that can be
applied to an element on the page, or add a snippet of code for a logo, button, or banner that
you received from a third-party provider.
In the following example, you will learn how to embed Google Font code, and declare custom
heading classes that override the current style sheet.
1. Visit the Google Fonts site and choose the font family that you want to use.
2. Copy the generated code that is to be embedded in the <head> section of the page, and paste it
temporarily into a text editor.
l CSS Rule
3. Add the font-family rule to each heading class. Then, enclose the heading classes in a <style>
tag. This is the code that will be pasted into Page Builder.
<link href="https://fonts.googleapis.com/css?family=Khand:600"
rel="stylesheet">
<style>
</style>
1. In the Admin sidebar of your store, choose Content. Then under Elements, choose Pages.
2. Find the page where the font is to be available, and open in edit mode. Then, scroll down to
the Content section.
3. In the Page Builder panel under Elements, drag an HTML Code placeholder to a row, column,
or tab set on the stage.
Use the red guideline to position the divider either before or after another content container in
the row, column, or tab set.
4. Hover over the container. Then in the toolbox, choose Settings ( ), and do the following:
a. In the text box, paste the embed Google Fonts code and style declarations that you
prepared. To make it easier to read, you can enter a few spaces to indent the code.
b. Update the remaining settings as needed, using the field descriptions at the end of this
page for reference.
5. In the upper-right corner, Save the settings and return to the Page Builder workspace.
The new font renders when the page is viewed through a browser.
Enable Page
b. In the upper-right corner on the Save menu, choose Save & Close.
7. Find the page in the grid. Then in the Actions column, select View.
HTML Code Settings
SETTING DESCRIPTION
(Text Box) A text box that is used to enter HTML, CSS, and JavaScript code.
Code snippets which belong in the <head> section of the page can be
entered here.
ADVANCED
Border Determines the border style that is applied to all sides of the divider
container. Options:
Border Color Determines the color of the container border. Specify the color by
choosing a swatch, clicking the color picker, or by entering a valid
color name or equivalent hexadecimal value.
Border Radius Specifies the size of the radius that is used to round each corner of
the container border.
CSS Classes Specifies the names of CSS classes from the current style sheet
which apply to the container. Separate multiple class names with a
space.
Margins and Padding Determines the size, in pixels, of the outer margins and inner padding
of the row. Enter each corresponding value in the row container
diagram. Options:
Media
Use the Media section of the Page Builder panel to add images, video, banners, sliders, and
Google Maps to any layout container on the stage. When a media content type is dragged from
the panel to the stage, a container appears with a toolbox of options that are specific to the
content type.
Image
Use the Image content type to add a JPG, GIF, or PNG image to the stage. In addition to the
default desktop image, you can specify a secondary image for mobile devices. You can also add
a caption that appears below the image, and link the image to any URL, product, category, or
page.
Image In Column
To add an image:
1. In the Page Builder panel under Media, drag an Image placeholder to the target container.
2. Use one of the following methods to upload a new image, or choose an existing image from the
gallery:
b. Navigate to the image in your local file system. Then, choose the image to add it to the
gallery and target container.
b. In the gallery, navigate to the image, and click the thumbnail. Then, tap Add Selected.
Image in Column
1. Hover over the image container. Then in the toolbox, choose Settings ( ).
Image Toolbox
The file name, dimensions, and file size appear below the current image.
Current Image
l Tap Upload. Then, navigate to the image in your local file system and choose the file.
l Tap Select from Gallery. Navigate to the image in the gallery. Then, click the thumbnail, and
tap Add Selected.
l Tap Upload. Then, navigate to the image in your local file system and choose the file.
l Tap Select from Gallery. Navigate to the image in the gallery. Then, click the thumbnail, and
tap Add Selected.
l Drag the image from a directory in your local file system, and drop it on the camera icon.
Mobile Image
4. To link the image(s), choose one of the following destination types, and follow the instructions.
URL
Link to URL
Product
Link to Product
l Click the down arrow, and choose the product from the list.
Choose Product
Category
Link to Category
Page
l Begin typing the page name. Then in the list, click the name of the page.
l Click the down arrow, and choose the page from the list.
Link to Page
If you want to prevent the visitor from navigating away from your store, mark the Open in new
tab checkbox.
5. To add an Image Caption, enter the text that you want to appear below the image.
The format of the caption is determined by the style sheet that is associated with the current
theme.
Image Caption
a. In the Alternative Text field, enter the “alt” text that you want to be available to improve
accessibility.
b. In the Title Attribute field, enter the text that you want to appear as a tooltip on
mouseover.
Both of these fields are visible to search engines, and improve the way the page is indexed.
7. Update the remaining settings as needed, using the field descriptions at the end of this page
for reference.
8. In the upper-right corner, tap Save to close the Edit Image page and return to the Page Builder
workspace.
To move an image:
1. Hover over the image container. Then in the toolbox, choose Move ( ).
Move Image
2. Hold down the mouse button, and drag the image to the new position, just below the red
guideline.
1. Hover over the image container. Then in the toolbox, choose Remove ( ).
Image Toolbox
TOOL ICON DESCRIPTION
Move Moves the image to another position on the stage.
Settings Opens the Edit Image page, where you can change
the properties of the image and container.
Upload New Image Uploads an image from your local file system to the
gallery.
Image Settings
SETTING DESCRIPTION
Image Adds an image that is intended to be viewed from a desktop
computer to the stage. You can add images directly to a row, column,
or tab.*
Maximum size: 4 MB
Supported file types: JPG, GIF, PNG
* The Banner and Slider content types also include Upload Image and
Select from Gallery options for desktop images.
Maximum size: 2 MB
Supported file types: JPG, GIF, PNG
* The Banner and Slider content types also include Upload Image and
Select from Gallery options for mobile images.
Link Adds a hyperlink to the primary desktop image, and to the mobile
image, if available. Options:
Open in new tab Determines whether a linked page opens in the same browser tab, or
in a new tab. Options:
Image Caption Specifies the caption that is associated with the image. The caption
typically appears below the image, and provides information about
the image for visitors and search engines. If your site is available in
multiple languages, you might use the same image, but translate the
caption. In HTML, the <figcaption> tag is a subset of the <figure>
tag.
<figcaption>This is the image caption</figcaption>
Search Engine Provides additional information to improve the way the image is
Optimization indexed by search engines. Options:
Title Attribute Specifies the text for a tooltip that appears when
you hover over the image. As a best practice,
choose a descriptive, keyword-rich title to
improve the way the image is indexed by search
engines. In HTML, the title attribute is a subset of
the image tag.
<image title="tooltip" alt="description"
src="image.jpg">
ADVANCED
Full Width Limits the image to the maximum page width that
is defined by the theme. However, the
background is not limited, and extends the full
width of the row.
Full Bleed Neither the image nor the background are limited,
and extend the full width of the row.
Top Left
Top Center
Top Right
Center Left
Center
Center Right
Bottom Left
Bottom Center
Bottom Right
Layout Determines the minimum height and vertical alignment of the row.
Options:
Video
Use the Video content type to add a video that is hosted on YouTube or Vimeo to the stage. It’s
easy to embed video in a page or block, as well as in product and category descriptions.
To add a video:
1. Before you begin, navigate to the YouTube or Vimeo video that you want to embed, and copy
the URL from the address bar.
2. In the Magento Admin, return to the Page Builder workspace where you want to add the video.
3. In the Page Builder panel under Media, drag a Video placeholder to the stage.
4. Hover over the video container. Then in the toolbox, choose Settings ( ), and do the
following:
Video Toolbox
a. Paste the URL of the video that you copied into the Video URL field.
The URL of the Page Builder video that is featured in this example is:
https://www.youtube.com/watch?v=Y0KNS7C5dZA
b. To limit the Maximum Width of the video, enter the maximum width in pixels.
If blank, the video will be as wide as allowed by the container, less margins and padding.
c. Update the remaining settings as needed, using the field descriptions at the end of this
page for reference.
5. In the upper-right corner, tap Save to close the Edit Video page and return to the Page Builder
workspace.
1. Hover over the video container. Then in the toolbox, choose Settings ( ), and do the
following:
Video Toolbox
b. To change the width of the video, enter the new Maximum Width in pixels.
c. Update the remaining settings as needed, using the field descriptions at the end of this
page for reference.
2. In the upper-right corner, tap Save to close the Edit Video page and return to the Page Builder
workspace.
To move a video:
1. Hover over the video container. Then in the toolbox, choose Move ( ).
Move Video
2. Hold down the mouse button, and drag the video to the new position, just below the red
guideline.
1. Hover over the video container. Then in the toolbox, choose Remove ( ).
Video Toolbox
TOOL ICON DESCRIPTION
Move Moves the video to another position on the stage.
Settings Opens the Edit Video page, where you can change the
properties of the video and container.
Video Settings
SETTING DESCRIPTION
Video URL The URL of a video that is hosted on either YouTube or Vimeo. The
URL can be copied from the address bar of the browser, and pasted
into the Video URL field.
Maximum Width Specifies the maximum width in pixels, that is allowed for the video in
the storefront. If blank, the video extends the full width of the
container, less allowance for margins and padding.
ADVANCED
Left Aligns the video along the left border of the parent
container, with allowance for any padding
specified.
Border Determines the border style that is applied to all four sides of the
video container. Options:
Border Color Determines the color of the container border. Specify the color by
choosing a swatch, clicking the color picker, or by entering a valid
color name or equivalent hexadecimal value.
Border Radius Specifies the size of the radius used to round each corner of the
border.
CSS Classes Specifies the names of CSS classes from the current style sheet
which apply to the container. Separate multiple class names with a
space.
Banner
Use the Banner content type to create an illustrated, interactive component that engages users
with a call to action and button.
Page Builder includes a new “Banner” content type. What was previously the “Banner” option in the
Content menu is now “Dynamic Block.”
To add a banner:
1. Open the page where you want to place the banner, and expand the Content section.
2. In the Page Builder panel on the left, expand the Media section. Then, drag a Banner
placeholder to the stage.
In addition to the toolbox, the Upload Image and Select from Gallery buttons are included so
you can make quick changes to the banner directly from the stage.
Banner Toolbox
4. In the Banner toolbox, choose Settings ( ). Then, complete the following:
Appearance
Banners are extremely easy to set up and maintain, because they are based on one of four
predefined templates.
l Poster
l Collage Left
l Collage Center
l Collage Right
Appearance
Background Color
l The rgba value for the color, with opacity percent, such as "rgba(255, 255, 255, 0.75)"
No Color
l In the color picker, drag the cursor to the color that you want.
Choose Swatch
2. Page Builder supports a transparency layer, or "alpha channel" that you can use to create
backgrounds with varying degrees of opacity. Do the following to set the opacity of the
background color:
The box below the slider shows the current red, green, blue, and alpha values (rgba). The
last number indicates the current opacity percentage as a decimal.
Set Opacity
Background Image
c. Navigate to the image in your local file system. Then, choose the file that you want to use.
The image is uploaded to the gallery, and a thumbnail of the uploaded image appears. The
file name, image dimensions, and file size are noted below.
d. At the Background Mobile Image field, tap Upload. Then, choose the image that you want
to use for mobile devices.
e. Scroll up to the top of the page. Then in the upper-right corner, tap Save to close the Edit
Banner page and return to the Page Builder workspace.
The background appears on the stage, and extends the full width of the row.
Banner Content
Notice the placeholder text that appears on the right side of the row. The position of this text
reflects the Appearance setting that you specified.
a. Click the placeholder text, and enter the text that you want to appear on the banner. The
editor toolbar appears above the text box.
c. Hover over the banner container. Then in the toolbox, choose Settings ( ).
You can enter and edit text from the stage or from Banner Settings.
Message Text
A banner can have either single, or multiple links and buttons. Use one of the following
methods to add links and/or buttons to the banner.
The banner Appearance setting places a single link or button below the text. Simply follow the
instructions below to complete the properties of the link or button that you want to add.
a. Create a separate block with the links or buttons that you want to include.
To avoid conflict, keep all the links or buttons in the separate block, and do not add a link or
button directly to the banner.
b. Add a block placeholder to the banner stage. Then, choose the block that you prepared,
and place it where you want it to appear on the banner.
a. Scroll down to the Link field below the Message Text box.
b. To link the banner, choose one of the following destination types, and follow the
instructions.
URL
Link to URL
Product
l Click the down arrow, and choose the product from the list.
Link to Product
Category
Link to Category
Page
l Begin typing the page name. Then in the list, click the name of the page.
l Click the down arrow, and choose the page from the list.
Link to Page
c. If the link points to a URL that is outside of your store, and you want to prevent the
visitor from navigating away from your store, mark the Open in new tab checkbox.
l Always
l On Hover
l Never Show
e. In the Button Text field, enter the text to appear on the button.
l Primary
l Secondary
l Link
The button style from the current theme determines the button format. Typically, a
primary button has a more prominent background color than a secondary button.
Banner Overlay
You can use an overlay to apply a background color to the active content area that is defined
by the Appearance setting. The banner background image continues to be visible for the full
width of the banner.
l Always
l On Hover
l Never Show
l In the No Color field, either enter a valid color name, or hexadecimal value.
Overlay Color
c. In the Overlay Transparency field, the percentage of transparency that you want to apply
for the overlay. For example, a transparency setting of 85% is the same as 25% opacity.
d. In the upper-right corner, tap Save. to close the Edit Banner page, and return to the Page
Builder workspace.
3. On the Save menu in the upper-right corner of the workspace, click the down arrow. Then,
choose Save & Close.
Save Menu
4. When prompted, click the Cache Management link in the message at the top of the page. Then
refresh any invalid cache.
Banner Toolbox
TOOL ICON DESCRIPTION
Move Moves the banner to another position on the stage.
Settings Opens the Edit Banner page, where you can change
the properties of the banner and container.
Upload New Image Uploads an image from your local file system to the
gallery for the banner background.
Select from Gallery Uses an existing image from the gallery for the banner
background.
Banner Settings
SETTING DESCRIPTION
APPEARANCE
BACKGROUND
Background Color Determines the background color and opacity of the row.
Background Image Determines the location of the background image file, and applies the
image to the banner. Options:
Background Mobile Image Determines the location of the background image file used for mobile
devices, and applies the image to the banner. If blank, the standard
desktop background image is used. Options:
Background Size Determines how the background image is scaled in relation to the
width of the banner. Options:
Background Position Determines the anchor point of the image in relation to the
banner. Options:
Top Left
Top Center
Top Right
Center Left
Center
Center Right
Bottom Left
Background Attachment Determines how the background image moves in relation to the
scrolling page. Options:
Background Repeat Determines if the background image is repeated to fill the available
space. Options:
CONTENT
Message Text A text box and editor that you can use to enter and edit the banner
message.
Link Determines the destination page that appears when the button or link
is clicked. Options:
Show Button Specifies if and when a button appears on the banner. Options:
Show Overlay Applies a background color to the text content area that is defined by
the Appearance setting. The banner background image or color
continues to be visible for the full width of the banner. Options:
Overlay Color Determines the color of the overlay. To specify the overlay color,
choose a swatch, click the color picker, or enter a valid color name or
hexadecimal value.
ADVANCED
Border Determines the border style that is applied to all sides of the banner
container. Options:
Border Color Determines the color of the container border. Specify the color by
choosing a swatch, clicking the color picker, or by entering a valid
color name or equivalent hexadecimal value.
Border Radius Specifies the size of the radius that is used to round each corner of
the container border.
Margins and Padding Determines the size, in pixels, of the outer margins and inner padding
of the banner container. Enter the corresponding values in the
diagram. Options:
Slider
Use the Slider content type to add a slideshow of images to the stage. You can upload new
images, or choose existing images from the gallery or product catalog. A slider can be set to
play automatically, or be controlled manually with navigation buttons. In the following
example, you will learn how to create a responsive slider that features and links to specific
products. To associate the slider with a specific promotion, see: Add Dynamic Block.
Slider in Storefront
1. Open the page, block, or dynamic block where you want to place the slider. Then, expand the
Content section.
2. In the Page Builder sidebar under Media, drag a Slider placeholder to a row, column, or tab on
the stage.
3. Sliders have two toolboxes. Hover anywhere over the slide to show the main toolbox at the top
of the container. Then, click the navigation dot at the bottom of the slide to show the toolbox
for individual slides.
1. On the individual slide toolbox, choose Settings ( ). Then, complete the settings, as needed,
in the following sections:
Appearance
l Poster
l Collage Left
l Collage Center
l Collage Right
Appearance
When you are working in Edit mode, the slide name appears as a tooltip above the
navigation dot. The slide name is not visible from the storefront.
The minimum height of the slide in this example is the default 300 pixels.
Background Color
Use one of the following methods to set the background color of the slide:
l The rgba value for the color, with opacity percent, such as "rgba(255, 255, 255, 0.75)"
In this example, the background color of the slide is the same yellow (#ffd16) as the
background color of the row.
Background Color
a. Click the swatch to the left of the "No Color" box. Then, do one of the following:
l In the color picker, drag the cursor to the color that you want.
Choose Swatch
b. You can use the opacity slider, just below the color picker, to create backgrounds with
varying degrees of transparency.
If you want a partially transparent background, drag the slider to the opacity setting that
you want to apply to the background color. Then, tap Apply.
The box below the slider shows the current red, green, blue, and alpha values (rgba). The
last number indicates the current opacity percentage as a decimal.
Set Opacity
Background Image
a. To add a standard Background Image for desktop devices, do one of the following:
l Tap Upload. Then, navigate to the image in your local file system, and choose the file
that you want to use. The image is uploaded to the gallery, and a thumbnail of the
uploaded image appears.
l Tap Select from Gallery. Find the image in the gallery. Then, click the thumbnail of the
image and tap Add Selected.
Background Image
l Tap Upload. Then, navigate to the image in your local file system, and choose the file
that you want to use. The image is uploaded to the gallery, and a thumbnail of the
uploaded image appears.
l Tap Select from Gallery. Find the image in the gallery. Then, click the thumbnail of the
image and tap Add Selected.
For mobile devices, the Background Mobile Image is used instead of the standard
background image.
c. To determine the size of the background image in relation to the width of the slide, set
Background Size to one of the following:
l Cover
l Contain
l Auto
In this example, the Background Size “Contain” prevents the background image from
extending the full width of the slide, which in this case is the full width of the row.
Rather, the background image is limited to the width of the active content area of the
slide, according to the slide’s Appearance setting.
Background Size
d. To anchor the image in relation to the slide, set Background Position to one of the
following positions at the top, center, or bottom of the slide:
l Left
l Center
l Right
e. If you want to repeat the background image, set Background Repeat to “Yes.”
Slider Content
a. In the Content section, enter the Message Text that you want to appear with the slide.
The first slide in this example has a background image, but no message text. The “Buy 3
Get 1 Free” text above the slider is in a Text container that will be added later.
Text can be entered and edited either from the stage or from Slider Settings.
Each slide can have either single, or multiple links and buttons. Use one of the following
methods to add links and/or buttons to a slide.
The slide Appearance setting places a single link or button below the text. Simply follow the
instructions below to complete the properties of the link or button that you want to add.
a. Create a separate block with the links or buttons that you want to include.
To avoid conflict, keep all the links or buttons in the separate block, and do not add a link or
button directly to the slide.
b. Add a block placeholder to the slide stage. Then, choose the block that you prepared, and
place it where you want it to appear on the slide.
a. To link the slide to a page, set Link to one of the following destination types. Then, follow
the instructions for the type of link you want to create.
The first slide in this example is linked to the Women >Tees category.
URL
Link to URL
Product
l Click the down arrow, and choose the product from the list.
Link to Product
Category
To choose the category, click the category name in the category tree.
Link to Category
Page
l Begin typing the page name. Then in the list, click the name of the page.
l Click the down arrow, and choose the page from the list.
Link to Page
b. If the link points to a URL that is outside of your store, and you want to prevent the
visitor from navigating away from your store, mark the Open in new tab checkbox.
l Always
l On Hover
l Never Show
d. In the Button Text field, enter the text to appear on the button.
l Primary
l Secondary
l Link
The button style from the current theme determines the button format. Typically, a
primary button has a more prominent background color than a secondary button. You can
find examples of primary and secondary buttons in the Magento Admin.
Slide Overlay
You can use an overlay to apply a background color to the active content area that is defined
by the Appearance setting. The slide background image continues to be visible for the full
width of the banner.
l Always
l On Hover
l Never Show
l In the No Color field, either enter a valid color name, or hexadecimal value.
Do not use the opacity slider in the color picker to set the overlay transparency.
Overlay Color
c. In the Overlay Transparency field, specify the percentage of transparency that you want
to apply for the overlay.
Overlay Settings
2. Complete the remaining settings as needed, using the field descriptions at the end of this page
for reference.
3. When complete, tap Save to close the Edit Slide page and return to the Page Builder
workspace.
You can save time by duplicating a slide that has already been configured with the needed
settings.
2. Click the navigation dot below the slide. Then in the slide toolbox, click Duplicate ( ).
3. Click the navigation dot for the new slide, and update the content and link as needed.
Duplicate Slide 1
1. Hover over the current slide. Then in the main slider toolbox, click Add ( ).
Slide 2 Toolbox
4. To view each image in the slider, click the next dot below the current image.
Completed Slider
The slide in this example has a background image, a transparent mobile image, and an inline
image that was added from the text editor. This technique works well on mobile devices by
turning off the background image, and displaying only the smaller inline image. The product
slide in this example has the following additional settings:
Background Image The image on this slide was saved from the product page, and uploaded
to the gallery.
Link Product
Border Solid
Border Width 1 px
If the slide is duplicated, you must update each duplicate slide with the correct information for
each tee shirt.
1. In the Page Builder panel under Elements, drag a Text placeholder to the top edge of the
slider. A red guideline marks the insertion point above the banner.
1. Hover over the slider container to show the main toolbox. Then, choose Settings ( ), and do
the following:
Slider Toolbox
a. If you want the slider to begin as soon as the page loads, set Autoplay to “Yes.” Then, set
Autoplay Speed to the number of milliseconds in the delay between slides. By default, the
Autoplay Speed is set to 4000 ms, which is four seconds.
Autoplay
b. To smooth the transition from one slide to the next, set Fade to “Yes.”
With Fade, the slides seem to stay in place, but the content changes smoothy from one to
the next. Without fade, you see the horizontal movement from one slide to the next.
c. To make the slideshow repeat indefinitely while the page is open, set Infinite Loop to
“Yes.”
d. To choose the type of navigation controls for the slider, do the following:
l To include “Next” and “Previous” arrows on the left and right side of each slide, set
Show Arrows to “Yes.”
l To include a set of navigation dots below the slider, set Show Dots to “Yes.”
Minimum Height
2. Complete the remaining slider settings as needed, using the field descriptions at the bottom of
this page for reference. Then on the Save menu, choose Save & Close to return to the Page
Builder workspace.
3. To test the slider in your store, scroll to the top of the page, and set Enable Page to “Yes.”
Then on the Save menu, choose Save & Close to return to the Pages grid.
4. To preview the slider, find the page in the grid. Then in the Action column, select View. When
you preview the slider, resize the window so you can see how it appears on a mobile device.
Desktop View
Mobile View
Settings Opens the Edit Slide page, where you can change the
properties of the current slide.
Slider Toolbox
TOOL ICON DESCRIPTION
Move Moves the slider to another position on the stage.
Settings Opens the Edit Slider page, where you can change the
properties of the video and container.
APPEARANCE
BACKGROUND
Background Color Determines the background color and opacity of the slide.
Background Image Determines the location of the background image file to use, and
applies the image to the slide. Options:
Background Size Determines how the background image is scaled in relation to the
width of the slide. Options:
Background Position Determines the anchor point of the image in relation to the slide.
Options:
Top Left
Top Center
Top Right
Center Left
Center
Center Right
Bottom Left
Bottom Center
Bottom Right
Background Repeat Determines if the background image is repeated to fill the available
space in the slide. Options:
CONTENT
Message Text A text box with editor that is used to enter and edit the text message
that appears on the slide.
Link Determines the destination page that appears when the slide button
is clicked. Options:
Show Button Specifies if and when a button appears on the slide. Options:
Button Text Determines the text that appears on the button. The button text can
be updated directly from the stage, or from the Edit Slide page.
Show Overlay Applies a background color to the content area that is defined by the
Appearance setting. The background image or color continues to be
visible for the full width of the slide. The overlay does not apply to
images that are added inline from the editor. Options:
Overlay Color Determines the color of the overlay. To specify the overlay color,
choose a swatch, click the color picker, or enter a valid color name or
hexadecimal value.
ADVANCED
Left Aligns the slide along the left border of the slider,
with allowance for any padding that is specified.
Right Aligns the slide along the right border of the slider,
with allowance for any padding that is specified.
Border Determines the border style that is applied to all four sides of the
slide. Options:
Border Color Determines the color of the slide border. Specify the color by
choosing a swatch, clicking the color picker, or by entering a valid
color name or equivalent hexadecimal value.
Border Radius Specifies the size of the radius that is used to round each corner of
the border.
CSS Classes Specifies the names of CSS classes from the current style sheet
which apply to the slide. Separate multiple class names with a
space.
Margins and Padding Determines the size, in pixels, of the outer margins and inner padding
of the slide. Enter the corresponding values in the diagram. Options:
Slider Settings
SETTING DESCRIPTION
SETTINGS
Autoplay Speed Specifies the delay in milliseconds between each slide when
Autoplay is used. Default value: 4000 ms (4 seconds)
Fade Determines if a fade effect is used to smooth the transition from one
slide to the next. Options:
Infinite Loop Determines if the slide show replays from the beginning after the last
slide. Options:
Show Arrows Determines if each slide includes “next” and “previous” navigation
arrows on the left and right side of each slide. Options:
Show Dots Determines if the slider includes navigation dots below the slides.
Options:
ADVANCED
Left Aligns the slider along the left border of the parent
container, with allowance for any padding that is
specified.
Border Determines the border style that is applied to all four sides of the
slider container. Options:
Border Radius Specifies the size of the radius that is used to round each corner of
the border.
CSS Classes Specifies the names of CSS classes from the current style sheet
which apply to the slider. Separate multiple class names with a
space.
Margins and Padding Determines the size, in pixels, of the outer margins and inner padding
of the slider container. Enter the corresponding values in the diagram.
Options:
Map
Use the Map content type to add a map from Google Maps Platform to the stage. For example,
you might add a map to a block, and then add the block to the About Us and Contact Us
pages.
To get the most from Google Maps Platform, you can customize the map, highlight your store
location(s), and use Google Places to add rich information about your store to all Google maps.
Before adding a map, you must first open an account for a free trial of Google Maps Platform.
The free trial lasts for twelve months, and includes a $300 credit. If you use up your credit,
Google will not bill your account without your permission.
1. In the Admin sidebar, choose Stores. Then under Settings, choose Configuration.
2. In the panel on the left under General, choose Content Management. Scroll down to the
Advanced Content Tools section. Then, complete the applicable instructions:
l If there is a problem with your key, return to the Google Maps Platform site to resolve
the problem. Then, try again.
To set up a Google Maps key, you must be a site administrator authorized to enable billing for
your account. If you’re not ready to set up a Google Maps Platform account at this time, you
can skip this step and use the placeholder map for now.
b. Follow the instructions to configure your Google Maps Platform account and billing.
c. Copy your API Key. Then, complete the previous instructions to enter and test your key.
To learn how to configure styles for your Google map, see Styling the Map.
1. Open the page, block, or dynamic block to the Page Builder workspace.
2. In the Page Builder panel, expand the Media section. Then, drag a Map placeholder to the
stage.
Google Maps
If Google Maps Platform isn’t yet configured for your store, a placeholder map appears instead.
1. Hover over the map container. Then in the toolbox, choose Settings ( ).
2. In the upper-right corner of the Edit Map page, tap Add Location.
3. Enter the Location Name that you want to be associated with the pin on the map.
Map Coordinates
b. In the upper-left corner, enter the address in the Search box, and click Search ( ).
c. Copy the coordinates in the URL, and paste them into a notepad.
a. Right-click the red pin that marks the location on the map. Then on the menu, choose
What’s here?
What’s here?
b. In the popup label, copy the text, including the coordinates. Then, Paste the text into a
notepad.
5. Return to the Add Location page and enter the numbers, without the comma, in the two
Coordinates fields. Then, enter as much of the remaining information that you want to be
available on the map.
The new location appears in the map, and in the map location grid on the Edit Map page.
Location Grid
1. In the Admin sidebar, choose Stores. Then under Settings, choose Configuration.
2. In the panel on the left under General, choose Content Management. Scroll down to the
Advanced Content Tools section.
3. In the note under the Google Maps Style field, click Create Map Style.
a. In the panel on the left, use the sliders to Adjust the density of roads, landmarks, and
labels on the map.
c. At the bottom of the panel, click More Options. Choose the Feature type and Element
type that you want to style. Then in the Stylers column, configure the properties as
needed.
You can export the completed style as JSON code or as a URL. Follow the instructions for
your application.
Export Style
JSON
1. Below the box with the generated JSON code, click Copy JSON.
2. Return to the Content Management section of the Magento Configuration. In the Advanced
Content Tools section, paste the code into the Google Maps Style field.
URL
1. Below the box with the generated URL, click Copy URL.
You can use this URL to link to your styled Google Map.
1. In the Admin sidebar, choose Stores. Then under Settings, choose Configuration.
2. In the panel on the left under General, choose Content Management. Scroll down to the
Advanced Content Tools section, and do the following:
a. Clear the checkbox after the Default Column Grid Size field. Then, enter a new value for
the default size of the grid.
b. Clear the checkbox after the Maximum Column Grid Size field. Then, enter a new value
for the default maximum grid size.
Map Toolbox
TOOL ICON DESCRIPTION
Move Moves the map to another position on the stage.
Settings Opens the Edit Map page, where you can change the
properties of the map and container.
Map Settings
SETTING DESCRIPTION
Map Locations A grid that lists the current map locations.
Add Location Adds a custom location to the map with the following information:
Location Name The name that you want to appear on the map.
Phone Number
MAP SETTINGS
ADVANCED
Left Aligns the map along the left border of the parent
container, with allowance for any padding that is
specified.
Right Aligns the map along the right border of the parent
container, with allowance for any padding that is
specified.
Border Determines the border style that is applied to all four sides of the map
container. Options:
Border Color Determines the color of the container border. Specify the color by
choosing a swatch, clicking the color picker, or by entering a valid
color name or equivalent hexadecimal value.
Border Radius Specifies the size of the radius that is used to round each corner of
the border.
CSS Classes Specifies the names of CSS classes from the current style sheet
which apply to the container. Separate multiple class names with a
space.
Margins and Padding Determines the size, in pixels, of the outer margins of the map
container. Enter the corresponding values in the diagram.
Padding N/A
Add Content
Use the Content section of the Page Builder panel to add existing content to the stage. When
you drag a media content type from the panel to the stage, a container appears with a toolbox
of options that are specific to the content type.
Add Block
Use the Block content type to add an existing, active block to the stage. In the following
example, the first column contains the HTML Code for the page. The second column contains a
block with a Google map.
1. Navigate to the Page Builder workspace on the target page, block, dynamic block, product, or
category.
2. In the Page Builder panel under Add Content, drag a Block placeholder to the stage.
Select Block
3. Hover over the empty block container. Then in the toolbox, choose Settings ( ), and do the
following:
Select Block
b. In the list of active blocks, find the row with the block that you want to add. In the first
column, tap Select. Then, tap Add Selected.
Selected Block
The name of the selected block appears in the form.
Block Name
c. Complete the remaining settings as needed, using the field descriptions at the end of this
page for reference.
1. Hover over the block container. Then in the toolbox, choose Settings ( ), and do the
following:
Block Toolbox
a. To choose a different block, tap Select Block. In the list of active blocks, Select the block
that you want to add. Then, tap Add Selected.
b. Update the remaining settings as needed, using the field descriptions at the end of this
page for reference.
To duplicate a block:
1. Hover over the block container. Then in the toolbox, choose Duplicate ( ).
2. To move the new block to a new position, hover over the container. Then in the toolbox, choose
Move ( ).
3. Hold down the mouse button, and drag the block until the red guideline appears at the new
position.
The top and bottom borders of each container appear as dashed lines while the block is being
moved.
1. Hover over the block container. Then in the block toolbox, choose Remove ( ).
Settings Opens the Edit Block page, where you can choose the
block, and change the properties of the container.
Block Settings
SETTING DESCRIPTION
Block The name of the selected block.
Select Block Displays a list where you can select an existing active block.
ADVANCED
Left Aligns the block along the left border of the parent
container, with allowance for any padding that is
specified.
Border Determines the border style that is applied to all four sides of the
block container. Options:
Border Color Determines the color of the container border. Specify the color by
choosing a swatch, clicking the color picker, or by entering a valid
color name or equivalent hexadecimal value.
Border Radius Specifies the size of the radius that is used to round each corner of
the border.
CSS Classes Specifies the names of CSS classes from the current style sheet
which apply to the container. Separate multiple class names with a
space.
Margins and Padding Determines the size, in pixels, of the outer margins and inner padding
of the block container. Enter the corresponding values in the diagram.
Options:
Dynamic Block
1. Navigate to the Page Builder workspace on the target page, block, product, or category.
2. In the Page Builder panel, expand the Add Content section. Then, drag a Dynamic Block
placeholder to the stage.
a. Hover over the empty Dynamic Block container. Then in the toolbox, choose Settings (
).
c. In the list, find the dynamic block that you want to insert, and tap Select. Then, tap Add
Selected.
Dynamic Block Inline Choose this template to insert the block content into text.
Template
Template
e. Complete the remaining settings as needed, using the field descriptions at the end of this
page for reference.
f. When complete, tap Save to close the Edit Dynamic Block page, and return to the Page
Builder workspace.
1. Hover over the dynamic block container on the stage. Then in the toolbox, choose Settings (
), and do the following:
b. In the list of active blocks, Select the block that you want to add. Then, tap Add Selected.
c. Update the remaining settings as needed, using the field descriptions at the end of this
page for reference.
1. Hover over the dynamic block container. Then in the toolbox, choose Duplicate ( ).
2. To move the new dynamic block to a different position, hover over its container. Then in the
toolbox, choose Move ( ).
3. Hold down the mouse button, and drag the dynamic block until the red guideline appears at
the new position.
The top and bottom borders of each container appear as dashed lines while the dynamic block
is being moved.
1. Hover over the dynamic block container. Then in the dynamic block toolbox, choose Remove (
).
Settings Opens the Edit Dynamic Block page, where you can
choose the dynamic block, and change the properties
of its container.
Select Block Displays a list where you can select an existing active block.
ADVANCED
Left Aligns the block along the left border of the parent
container, with allowance for any padding that is
specified.
Border Determines the border style that is applied to all four sides of the
block container. Options:
Border Color Determines the color of the container border. Specify the color by
choosing a swatch, clicking the color picker, or by entering a valid
color name or equivalent hexadecimal value.
Border Radius Specifies the size of the radius that is used to round each corner of
the border.
CSS Classes Specifies the names of CSS classes from the current style sheet
which apply to the container. Separate multiple class names with a
space.
Margins and Padding Determines the size, in pixels, of the outer margins and inner padding
of the block container. Enter the corresponding values in the diagram.
Options:
Add Products
Use the Products content type to add a list of products to the stage. You also can use the Add
Content - Block tool to place the block, with product list, on the Page Builder stage. Or, you
can add the product list directly to a row on a page.
The following example shows how to add a product list to a block. A widget can then be used
to place the block at a specific location on any page in your store.
a. Enter the Block Title and Identifier. Then, choose the Store View where the block is to be
available.
b. Scroll down to the Page Builder workspace. Then in the Page Builder panel under Add
Content, drag a Products placeholder to the stage.
Add Products
3. Hover over the empty container. Then in the toolbox, choose Settings ( ).
Products Toolbox
4. To describe the condition that determines which products are included, do the following:
a. On the Edit Products page under Condition, click Add ( ). Then under Product
Attribute, choose Category.
Condition
b. To complete the “Category is ...” part of the condition, click More (...). Then after the field,
click the Chooser ( ).
Condition
c. In the category tree, drill down to the Women > Tops category, and mark the Tees
checkbox.
Category Tree
Product List
e. In the upper-right corner, tap Save to return to the Page Builder workspace.
5. In the upper-right corner on the Save menu, tap Save & Close.
6. You can now use a widget to place this block wherever you want it to appear in the store. Or,
use Add Content - Block to add the block to an existing page, tab, or block.
Settings Opens the Edit Products page, where you can choose
the product selection, and change the properties of its
container.
Products Settings
SETTING DESCRIPTION
Condition Defines the query that retrieves the products for the list.
ADVANCED
Border Determines the border style that is applied to all four sides of the
products container. Options:
Border Color Determines the color of the container border. Specify the color by
choosing a swatch, clicking the color picker, or by entering a valid
color name or equivalent hexadecimal value.
Border Radius Specifies the size of the radius that is used to round each corner of
the border.
CSS Classes Specifies the names of CSS classes from the current style sheet
which apply to the container. Separate multiple class names with a
space.
Margins and Padding Determines the size, in pixels, of the outer margins and inner padding
of the products container. Enter the corresponding values in the
diagram. Options:
1493
Contents
Your store's theme is like a window dressing that Design Menu
can be changed for a season or promotion. In this
section, you will learn about page layouts, how to Page Setup
make simple HTML changes, and apply a new HTML Head
theme to your store. Header
Footer
Page Layout
Standard Page Layouts
Storefront Examples
Layout Updates
Standard Block Layout
Layout Update Examples
Layout Update Syntax
Controlling Block Order
XML Load Syntax
Themes
Using the Default Theme
Installing a New Theme
Theme Assets
Scheduling Design Changes
Content Staging
Content Staging Workflow
Scheduling an Update
Staging Dashboard
Editing a Campaign
Adding an Item
Previewing a Campaign
1494
CHAPTER 67:
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 appreciate the flexibility of working with an object-oriented 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
Menu Options
Configuration
The Design configuration lets you easily maintain
different settings for each website, store, and view in
your Magento installation.
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.
Staging
Content Staging gives your business team the ability
to easily create, preview, and schedule a wide range of
content updates directly from the Admin of your
store.
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
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.
a. Under Design Rule section under User Agent 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.
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. Then, follow the instructions in the linked topics to
edit the settings as needed.
l Pagination
l HTML Head
l Header
l Footer
l Transactional Emails
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.
2. Find the store view that you want to configure. Then in the Action column, click Edit.
4. Update the fields as needed. (See the following Field Descriptions for more information about
each item.)
HTML Head
Field Descriptions
FIELD SCOPE DESCRIPTION
Favicon Icon Store View Uploads the small graphic image that appears in the
address bar and tab of the browser. Allowed file types:
ICO, PNG, APNG, GIF, and JPG (JPEG).
Not all browsers support these formats.
Page Title Prefix Store View A prefix can be added before the title to create a two-
or three-part title. A vertical bar or colon can be used
as a separator at the end of the prefix to differentiate it
from the text of the main title.
Page Title Suffix Store View A suffix can be added after the title to create a two-or
three part title. A vertical bar or colon can be used as a
separator at the end of the prefix to differentiate it from
the text of the main title.
Default Meta Description Store View The description provides a summary of your site for
search engine listings and should not be more than
160 characters in length.
Default Meta Keywords Store View A series of keywords that describe your store, each
separated by a comma.
Scripts and Style Sheets Store View Contains scripts that must be included in the
HTML before the closing <head> tag. For example,
any third-party JavaScript that must be placed before
the <body> tag can be entered here.
Display Demo Store Store View Controls the display of the demo store notice at the
Notice top of the page. Options include: Yes / No
Header
The Header section identifies the path to your store logo, and specifies the logo alt text and
welcome message.
Header
2. Find the store view that you want to configure. Then in the Action column, click Edit.
4. Make any changes necessary to the logo and welcome message settings.
Field Descriptions
FIELD SCOPE DESCRIPTION
Logo Image Store View Identifies the path to the logo that appears in the
header. Supported file types: PNG, GIF, JPG (JPEG)
Logo Attribute Width Store View The width of your logo image in pixels.
Logo Attribute Height Store View The height of your logo image in pixels.
Welcome Text Store View The welcome message appears in the header of the
page and includes the name of customers who are
logged in.
Logo Image Alt Store View The Alt text that is associated with the logo.
Footer
The Footer configuration section is where you can update the copyright notice that appears at
the bottom of the page, and enter miscellaneous scripts that must be positioned before the
closing <body> tag.
Footer
2. Find the store view that you want to configure. Then in the Action column, click Edit.
4. Make any changes necessary to the Copyright and Miscellaneous HTML settings.
Field Descriptions
FIELD SCOPE DESCRIPTION
Copyright Store View The copyright statement that appears at the bottom of
each page. To include the copyright symbol, use the
HTML character entitym © as follows:
© 2014 Magento Demo Store. All Rights
Reserved.
Make sure to replace the sample copyright notice with
your own.
Miscellaneous HTML Store View An input box where you can upload miscellaneous
scripts to the server that must be placed just before
the closing <body> tag.
On the page, content blocks float to fill the available space, according to the section of the page
layout 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.
Default Layouts
a. Choose the Default Product Layout that you want to use for product pages.
b. Choose the Default Category Layout that you want to use for category pages.
c. Choose the Default Page Layout that you want to use for CMS pages.
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.
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.
1 Column 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
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 update2 refers to a specific set of XML instructions that determines how the
page is constructed.
The XML layout of your Magento Commerce 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 Widget tool. To place a block of
content as a widget, you must identify the page, and the location on the page where you want
the block to appear. You can use the Widget 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.
Block Descriptions
BLOCK TYPE DESCRIPTION
page/html 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 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.
page/html_notices 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.
page/html_header 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 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.
page/template_links 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.
page/switch 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.
core/messages 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.
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.
Full Syntax
<action method="someActionName">
<arg1>Value 1</arg1>
<arg2>Value 2</arg2>
<!-- -->
<argN>Value N</argN>
</action>
<!-- -->
Simplified Syntax
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 DESCRIPTION
setBlockId($blockId) Specifies the ID of a CMS block, so its content can be fetched
and displayed when the page is rendered.
<!--...-->
<reference name="content">
<action method="setBlockId"><id>additional_info</id></action>
</block>
</reference>
<!-- -->
core/text
A core/text block can be used to enter free form text directly into the template.
Syntax
ACTION DESCRIPTION
addText($textContent) 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">
<action method="addText">
</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.
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:
<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 VALUE
type * 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.
as 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.
<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 VALUE
name * 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 VALUE
method * 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 VALUE
name * 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.
Syntax
NAME VALUE
name * block name
The name of any block to be extended.
* any other
Any other attribute specific for the <block> instruction.
before="-" Places the block at the top of the sidebar, before other blocks.
after="-" Places the block at the bottom of the sidebar, after other blocks.
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.
A responsive theme adjusts the page layout to fit the view port of the device. Magento’s sample
“Luma” theme has a flexible, responsive layout that can be viewed from the desktop, tablet, or
mobile device.
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
Themes
1. On the Admin sidebar, tap Content. Then under Design, choose Themes.
2. Tap Filters.
3. To filter, enter an ID range, theme name (or title), folder path, or parent theme.
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.
Preview 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
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
Magento Marketplace
l Find a Theme
l Make a Purchase
3. To apply the theme to your store, see: Using the Default Theme,
Theme Assets
The term static files1 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 Base URL
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.
Fonts 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
Images 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
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.
CSS Settings
JavaScript Settings
2. Tap Add Design Change. Then under General Settings, do the following:
c. To define the period when the change is in effect, use the calendar ( ) to choose the
values for the Date From and Date To fields.
The term “campaign” refers to the record of a scheduled change—or collection of changes—that
might be viewed on a calendar or timeline, and managed from the Staging Dashboard. The
term “scheduled change” and “scheduled update” are interchangeable, and refer to a single
change.
When you schedule a content change for a specific period of time, the content reverts to the
previous version when the scheduled change expires. You can create multiple versions of the
same baseline content to be used for future updates. You can also step back through the
timeline to view previous versions of the content. To save a draft version, simply assign a date
on the timeline that is so far into the future that it will never go into production.
When any of the following content assets are created, an corresponding campaign is set up as a
placeholder, and the Scheduled Changes box appears across the top of the page. The
placeholder campaign has a start date, but not an end date. You can schedule updates to the
content as part of a campaign, and then preview and share the changes by date, time, or store
view.
l Products
l Categories
l CMS Pages
l CMS Blocks
l Widgets
The Staging Dashboard provides visibility into all planned site changes and updates. Any day,
range of dates, or time period of a campaign can be previewed, and shared with others.
Create the first campaign. Create your first campaign with the start and end dates as
needed. To make the campaign open-ended, leave the End Date blank. When the first
campaign ends, the original baseline content is restored.
Add a second campaign. Create the second campaign, with the start and end dates as
needed. The second campaign can be assigned to an entirely different time period. When
creating multiple campaigns for the same asset, the campaigns cannot overlap. You can
create as many campaigns as needed.
Restore the baseline content. If all campaigns have end dates, the baseline content is
restored whenever all active campaigns end.
Scheduling an Update
The following example shows how to schedule a temporary price change for a product. You will
learn how to schedule and preview changes, and also how to view scheduled updates on the
calendar. Although this example includes only a single change, a campaign might include
multiple changes to products, price rules, CMS pages, and other entities that are scheduled to
take place at the same time.
2. In the Scheduled Changes box at the top of the page, tap Schedule New Update.
a. In the Update Name field, enter a name for the new content staging campaign.
c. Use the Calendar ( ) to choose the Start Date and End Date for the campaign.
To create an open-ended campaign, leave the End Date blank. For this example, the
campaign is scheduled to begin the minute the sun reaches the northernmost point of the
equator. This year, the summer solstice takes place on June 20th, at 3:34 AM PST.
An end date cannot later be added to a price rule campaign that was originally created without
an end date. In such a case it is necessary to create a duplicate campaign that includes the end
date that is needed
5. Enter a Special Price for the product during the scheduled campaign. Then, tap Done.
The scheduled change appears at the top of the product page, with the start and end dates of
the campaign.
Scheduled Change
3. Tap Save.
The Preview opens a new browser tab, and shows how the product will appear during the
scheduled campaign.
The calendar detail shows other campaigns that are scheduled for the same day. Each record in
the list is a separate campaign.
3. To preview a different day or time, tap the Date & Time calendar . Then do the following:
b. Tap Preview.
In this example, the regular price is restored because the special price is no longer in effect.
4. To return to the campaign calendar, tap Calendar in the header of the Preview page. From
here, you can do the following:
5. If necessary, return to the campaign calendar. To view your scheduled change as part of a
campaign, select View/Edit in the Action column of the list.
The page includes the general description of the campaign, with a section for each type of
entity that might be included.
Edit Campaign
The Staging Dashboard provides an overview of all active and upcoming campaigns. Although
in this example we arrived at the Staging Dashboard after previewing a scheduled change, it
can also be directly accessed from the Content menu. The campaign that we created includes
one object—or entity—which is the product that was updated. To learn more, see Staging
Dashboard.
Staging Dashboard
Staging Dashboard
The Staging Dashboard provides an overview of all active and upcoming campaigns. The
format of the dashboard can be changed from a grid to a timeline. You can also use filters to
find campaigns, customize the column layout, and save different views of the grid. To learn
more about the workspace controls, see: Admin Workspace.
Grid View
3. To change the format of the dashboard, set the View As control to “Timeline.”
Timeline View
The slider in the lower-right corner can be used to adjust the view from one to four weeks.
Each column represents one day.
4. Drag the slider to the “4w” position on the far right. The campaign that is scheduled for June
20 is now visible in the timeline.
4-Week View
5. Click any item in the timeline to display general information about the campaign.
l To see how the campaign will look to customers in the store on that day, tap Preview.
Campaign Information
Editing a Campaign
Existing campaign objects can be edited from the Dashboard, with the exception of price rule
campaigns that do not have end dates.
If a campaign that includes a price rule is initially created without an end date, the campaign cannot
later be edited to include an end date. In such a case, it is necessary to create a duplicate campaign
and enter the end date that is needed.
Follow the steps below to edit any of the objects in this campaign.
Campaign Detail
To edit a campaign:
1. On the Admin menu, tap Content. Then under Staging, choose Dashboard.
The campaign in this example includes two CMS pages and three products.
4. Expand the section that contains the item to be edited. Then, do the following:
b. Tap Save.
Adding an Item
In this example, we will add an image to the category page for the duration of the campaign.
c. At the Category Image field, tap Upload. Then, navigate to the image that is to appear on
the category page during the campaign.
5. On the Admin menu, tap Content. Then under Staging, choose Dashboard.
Campaign Detail
6. Find the campaign in the list. Click once to view the detail, and tap View/Edit.
Previewing a Campaign
Any day or period of time during a campaign can be previewed and shared with others.
Preview
To preview a campaign:
1. Do one of the following:
l On the Admin menu, tap Content. Then under Staging, choose Dashboard.
l On a page with a Scheduled Changes box at the top of the page, click Preview.
The Preview opens a new browser tab, and shows how the product will appear during the
scheduled campaign.
The calendar detail shows other campaigns that are scheduled for the same day. Each record in
the list is a separate campaign.
3. To preview a different day or time, tap the Date & Time calendar ( ). Then do the following:
b. Tap Preview.
In this example, the regular price is restored because the special price is no longer in effect.
4. To change the scope of the preview for a different store view, do the following:
b. Choose the Website, Store or Store View that you want to preview.
a. Tap Share. Then, press Ctrl + C to copy the link to the clipboard.
6. To return to the campaign calendar, tap Calendar in the header of the Preview page.
1550
Contents
In this section of the guide, you will become Customers Menu
familiar with the customer account dashboard,
and learn to configure customer accounts All Customers
according to your preference. You will also learn Now Online
how to create customer groups that can be
Customer Accounts
referenced in promotions and tax classes.
Customer Sign In
Account Dashboard
Configuring Customer Accounts
Online Session Length
Login Landing Page
New Account Options
Name and Address Options
Password Options
Customer Groups
Customer Segments
Customer Segment Attributes
Creating a Customer Segment
Targeting Customer Segments in Price Rules
Targeting Customer Segments with Banners
Customer Segment Reports
1551
CHAPTER 72:
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
Menu Options
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.
Customer Groups
The customer group determines which discounts are
available to shoppers, and the tax class applies to the
purchase.
Segments
Dynamically display content and promotions to specific
customers, based on properties such as customer
address, order history, shopping cart contents, and more.
All Customers
The Customers grid lists all customers who have registered for an account with your store, or
were added by the administrator. Use the standard grid controls to filter the list, and adjust
the column layout. To learn more, see: Managing Customer Accounts.
All Customers
2. Find the customer record. Then in the Action column, click Edit.
3. In the panel on the left, choose the information you need to edit. Then, make the necessary
changes. To learn more, see: Updating Customer Accounts.
Now Online
The Now Online option on the Customers menu lists all customers and visitors who are
currently online in your store. The interval of time that customers are shown as currently online
is set in the configuration, and determines how long the customer’s activity is visible from the
Admin. By default, the interval is fifteen minutes.
Online Customers
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
a. In the Online Minutes Interval field, enter the number of minutes for the customer session
to be visible from the Admin. Leave the field empty to accept the default interval of fifteen
minutes.
b. In the Customer Data Lifetime field, enter the number of minutes before any unsaved data
entered by the customer expires.
Column Descriptions
COLUMN DESCRIPTION
ID The customer ID of a registered customer.
IP Address The IP address of the computer that customers and guests are using
to access your store.
Session Start Time The date and time that marks the beginning of the current customer
session.
Last Activity The date and time of the customer’s last activity in your store.
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, wish list, and more.
My Account
l Account Scope
l Password Options
Login Options
4. Set Redirect Customer to Account Dashboard after Logging in to one of the following:
Yes The account dashboard appears when customers log in to their accounts.
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.
1. 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.
2. 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.
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
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 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.
By Email The password can be reset only by responding to an email notification that is
sent to the email address associated with the Admin account.
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.
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.
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.
Session Information that is stored on the server, such as the contents of the
shopping cart. If the server session expires before the cookie expires,
customers might lose the cart contents and reduce security risk.
If Persistent Cart is enabled, the cart contents are saved for the next time customers sign into
their accounts. When using a persistent cart, it is recommended that you set the lifetime of the
server session and the session cookie to a long period of time.
On the server, the length of the session is controlled by php.ini, and several variables. At this
time, Magento does not have an Admin configuration setting that controls the length of the
server session.
2. If you have multiple stores, set the Store View chooser in the upper-right corner to the store
where the configuration applies.
5. To change the default, clear the Use system value checkbox. Then, enter the new value in
seconds.
The following instructions represent the default customer account configuration. To change the
selection and behavior of some of the fields in the form, see: Configuring Account Options.
Create an Account
1. From the storefront, click the Create an Account link in the upper-right corner of the header.
2. Under Personal Information, enter your First Name and Last Name.
Personal Information
3. If you want to add your name and email address to the list of newsletter subscribers, mark the
Sign Up for Newsletter checkbox.
This email address will become part of your sign-in credentials, and cannot be associated with
any other customer account.
Sign-in Information
l Lowercase characters
l Uppercase characters
l Numbers
l Special Characters
After you press Enter, the strength of the password is evaluated, and appears below the field. If
the password is considered to be “Weak,” try another until it evaluated as “Strong”.
You can now use your email address and password to sign in to your account to complete the
address information.
Customer Information
a. For a multisite installation, set Associate to Website to the website where the
customer account applies.
l First Name
l Last Name
l Email
l Name Prefix
l Middle Name/Initial
l Name Suffix
l Date of Birth
l Tax/VAT Number
l Gender
4. Set Send Welcome Email From to the store view from which the Welcome email is to be
sent.
If the store has views for different languages, this setting determines the language of the
Welcome email.
5. If Vertex Cloud is enabled, enter the Vertex Customer Code that you want to use for this
customer.
After 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 the
account.
Customer View
1. In the panel on the left, choose Addresses. Then, tap Add New Addresses.
2. If the same address is used for both billing and shipping, toggle both options.
Add an Address
3. Scroll down and complete the required address fields in the second column.
l Street Address
l City
l Country
l State/Province
l ZIP/Postal Code
6. If this is the only address that is needed for the account, tap Save. Otherwise, tap Save
and Continue Edit. Repeat to add additional addresses.
The new address displays in the Addresses view with the selected Default Billing and Default
Shipping addresses above the full list.
Addresses view
The new customer account now appears in the Customers grid.
Customers grid
3. In the menu bar at the top of the page, click Reset Password.
Notification is sent to the account owner, with instructions for setting the password.
Button Bar
BUTTON DESCRIPTION
Additional buttons become available when the profile is saved for the first time. To learn more,
see: Updating a Customer Profile.
Delete Customer Deletes the current customer. Completed orders associated with the
customer are not removed.
Reset Resets any unsaved changes in the customer form to their previous
values.
Force Sign-in Revokes the OAuth access tokens that are associated with the
customer account. This can be used only with customer accounts
that have been assigned OAuth tokens, as part of a Web API
integration. To learn more, see: OAuth-based authentication.
Manage Shopping Cart Allows the administrator to manage the shopping cart for the
customer.
Field Descriptions
FIELD DESCRIPTION
ACCOUNT INFORMATION
Associate to Website Identifies the website associated with the customer account.
Name Prefix If used, the prefix that is associated with the customer’s name. For
example: Mr., Ms, or Dr.
The prefix values are determined by the configuration. Depending on
the configuration, the input control might be a text field or a drop-
down list of options.
Middle Name / Initial The middle name or initial of the customer. This field is included only
if specified in the configuration.
Name Suffix If used, the suffix that is associated with the customer's name. For
example: Jr.,Sr., or III.
The suffix values are determined by the configuration. Depending on
the configuration, the input control might be a text field or a drop-
down list of options.
Date of Birth The customer’s date of birth. The date of birth is included if specified
in the configuration.
Tax / VAT Number The customer's Tax or Value Added Tax number, if applicable.
Send Welcome Email If you have multiple store views, identifies the store view from which
From the Welcome message is sent. If store views are used for different
languages, this determines the language of the Welcome email.
Vertex Customer Code (Requires Vertex Cloud) A unique code that is referenced for
customer exceptions. The code can be an abbreviation of the
customer name, number, or alphanumeric string.
ADDRESSES
Add New Addresses Displays another New Address section to identify the type of the
address to be entered.
Street Address The street address of the customer. A second line of the street
address is available if specified in the configuration.
Zip/Postal Code The ZIP or postal code where the customer address is located.
Phone Number The customer’s phone number that is associated with address.
VAT Number If applicable, the value added tax number that applies to the
customer at this address.
All Customers
To apply an action:
The following actions can be applied to either single or multiple records.
2. In the first column of the grid, mark the checkbox of each record that you want to update.
Then, follow the instructions for the action that you want to apply:
Deleted customer accounts cannot be restored. Information about customer activity and
transactions is retained in the system.
Subscribe to Newsletter
2. Choose the customer group to which all selected customer records are to be assigned.
1. In the first column, mark the checkbox of the customer account to be edited.
The value of each value that can be updated appears in a text box. Only some values
of the selected customer record can be edited from the grid.
Quick Edit
l Email
l Group
l Phone
l ZIP
l Web Site
l Tax/VAT Number
l Gender
4. Tap Save.
Actions Control
OPTION DESCRIPTION
Delete Deletes selected customer accounts.
Column Descriptions
FIELD DESCRIPTION
Select Mark the checkbox to select customer records that are to be subjects
of an action. Or, use the selection control in the column header to
select/deselect all.
Customer Since The date and time the customer account was created.
Web Site The web site in the store hierarchy to which the customer account is
associated.
Account Created In Indicates the store view from which the customer account was
created.
Tax / VAT Number If applicable, the tax number or value-added tax number that is
assigned to the customer.
ADDITIONAL COLUMNS
The following columns are available by changing the column layout of the grid.
Billing Firstname The first name in the billing address of the customer.
Billing Lastname The last name in the billing address of the customer.
VAT Number The value-added tax number that is associated with the customer
address. For digital goods sold in the EU, the VAT is based on the
billing address of the customer.
Account Lock Indicates the status of the account. As a security measure, customer
accounts can be locked after too many login attempts. Values:
Locked / Unlocked
Customer Profile
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 field values, using the field descriptions for reference.
Button Bar
BUTTON DESCRIPTION
Back Returns to the Customers page without saving changes.
Reset Resets any unsaved changes in the customer form to their previous
values.
Create Order Creates a new order that is associated with the customer account.
Force Sign-In Clears the tokens associated with the customer’s password, and
provides the administrator access to the account,
Save and Continue Edit Saves changes, and keeps the customer account open.
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.
If Amazon Pay is enabled for your store, customers who sign in with the credentials from their
Amazon account can use the shipping addresses and payment methods that are available in
their Amazon account during checkout. Login with Amazon requires customers to grant
permission to share data from their Amazon accounts with your store.
If a CAPTCHA enabled in the configuration, the person must correctly complete a test that
verifies them to be human, before gaining access to their accounts.
When customers forget their passwords, a reset link is sent to the email address that is
associated with the account. The number of times a customer can try to enter a password, the
number of minutes between attempts, the number of total attempts before the account is
locked, and the length of the lockout is set in the Password Options configuration.
Sign In
Customer Login
2. Enter your Email address and Password. Then, tap Sign in.
If you can’t remember your password, click Forgot Your Password? Then, follow the
instructions to reset your password.
3. When prompted to sign in, enter the email address and password for your Amazon buyer
account.
4. To grant Amazon permission to share the following information from your account with the
store when processing your purchases, tap Okay.
l Your Name
l Shipping Addresses
Resetting Passwords
Customers usually reset their passwords from the storefront by clicking the “Forgot Your
Password?” link.
However, the store administrator can initiate either a password reset or a forced sign-in from
the Admin.
Reset Password A password reset email is sent directly to the customer’s email account.
At no time does the store administrator gain access to the customer’s
password.
Force Sign In Revokes the OAuth access tokens that are associated with the customer
account. This can be used only with customer accounts that have been
assigned OAuth tokens, as part of a Web API integration. To learn more,
see: OAuth-based authentication.
2. When prompted, enter the Email Address that is associated with your account, and tap Reset
My Password.
3. When the email arrives, click the reset password link, 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
sign in to your account.
2. Find the customer account in the grid. Then in the Action column, click Edit.
3. In the set of options across the top of the page, tap Reset Password.
The number of password reset requests that are allowed within an hour is set in the
configuration.
Do not proceed unless you are a developer familiar with API Authentication.
2. Find the customer account in the grid. Then in the Action column, click Edit.
3. In the set of options across the top of the page, tap Force Sign In.
Account Dashboard
Customers can manage and monitor their own information and activities from their accounts.
Customers can reorder, track orders, manage shipping addresses and payment methods,
product reviews, newsletter subscriptions, and more.
My Account
Account Dashboard
SECTION DESCRIPTION
My 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.
Order by SKU Gives you the ability to add individual items to the cart by SKU, or
import a list of products to be ordered from a CSV file.
My Downloadable Lists all downloadable products the customer has purchased, with a
Products link to each.
My Wish List Manage your wish lists, and place orders from wish list items.
Address Book The customer address book includes the default billing and shipping
address, and additional address entries.
Store Credit Displays the current amount of store credit from returns, refunds, and
redeemed gift card that can be applied to purchases.
Stored Payment Methods Lists any payment methods with secure vaults that are used by the
customer to store credit card information.
Gift Card Allows customers to check the current balance on available gift
cards, and to redeem gift cards for store credit.
Reward Points Lists all reward points the customer has earned that can be applied
toward purchases.
Gift Registry Used to list and maintains gift registries, and add new ones.
My Product Reviews Displays a list of all product reviews submitted by the customer, with
a link to each.
Newsletter Subscriptions Lists all available newsletters. Those to which the customer is
currently subscribed have a checkmark.
My Invitations Lists all invitations the customer has created and sent for scheduled
events.
My Orders
You have access to all of your orders from your account dashboard. Orders can be viewed,
tracked, and resubmitted as new orders. Depending on the status of the order, you can print
orders, invoices, and shipment records.
My Orders
To view an order:
Find the order in the list, and click View Order. Then from the open order, do any of the
following:
Reorder
1. To create a new order that is a duplicate of the current order, click the Reorder link.
2. When the shopping cart appears with the items from the order, you can either continue
shopping, or proceed to checkout.
Print Order
3. Tap Print.
Print Order
Print Invoices
l Print Invoice
3. Tap Print.
Invoices
Print Shipments
l Print Shipment
3. Tap Print.
Order Shipments
Track a Shipment
Print Refunds
l Print Refund
3. Tap Print.
Refunds
My Downloadable Products
The My Downloadable Products page links to each order of downloadable products. The
downloads become available from the dashboard as soon as the order is complete.
My Downloadable Products
To download a product:
1. In your account dashboard, choose My Downloadable Products.
2. Find the order in the list, and click the download link after the title.
3. In the lower-right corner of the download window, click the download icon.
4. Look for the name of the download file to appear in the lower-left corner of the window. Then,
save the file.
Download Video
Order by SKU
Order by SKU gives you the ability to add individual products to your cart by SKU and
quantity, or import a list of products from a file.
Order by SKU
2. Tap Add ( ) for each additional product that you want to order. Then, enter the SKU
and Qty for each line item.
a. In a spreadsheet, create a file with the column headers “sku” and “qty” in lowercase
characters.
b. Enter the sku and qty of each product that you want to import.
SKUs to Import
Microsoft Excel supports several CSV formats, including CSV (Comma delimited), CSV
(Macintosh), and CSV (MS-DOS).
2. On the Order by SKU page, tap Choose File. Then, find the CSV file that you prepared
and saved.
2. If any of the products have additional options, you will be prompted from the shopping cart
that the product requires your attention.
If you entered duplicate SKUs, the quantities will be combined into a single line item in the shopping
cart. Before placing the order, check the quantity ordered to make sure that’s it’s correct. If you
change the quantity of any item, tap Update Shopping Cart to recalculate the totals.
My Wish List
Your wish list is a convenient way to keep track of products that you like, but are not ready to
buy. Items from your wish list can be shared with others, or added to the shopping cart.
My Wish List
1. From your wish list, point to the product to display the options.
2. To add a Comment about the product, enter the text in the box below the price.
Edit Options
3. To change the selection of product options, click Edit. Then, do the following:
1. In your wish list, point to the product that you want to add.
2. Enter the email address of each person who is to receive your wish list, separated by a comma.
The message is sent from your primary store contact, and includes a thumbnail image of each
product, with links to your store.
Address Book
Customers who keep their address books current can speed through the checkout process. The
address book contains the customer’s default billing and shipping addresses, and any
additional addresses that they frequently use. Additional address entries are easy to access and
maintain from the grid. Each customer’s address book can manage over 3,000 address book
entries without impacting performance.
Address Book
2. On the Address Book page under Additional Address Entries, tap Add New Address. Then, do
the following:
By default, the customer’s first and last names initially appear in the form.
b. Mark the following checkboxes to indicate how the address is to be used. Mark both
checkboxes if the same address is used for billing and shipping.
Account Information
The basic account information includes your name and email address, and password, and can
be maintained from your account dashboard.
Account Information
Additional fields appear as part of the name if the Customer Configuration includes a
prefix, middle initial, and suffix.
2. Tap Save.
4. Tap Save.
Choose a strong password that is at least eight characters long. Your password can
include a combination of upper and lowercase letters, numbers, and symbols. Use the
password strength indicator to help you choose the best password. Then, write it down.
Change Password
Store Credit
The Store Credit section of your account dashboard lists amounts from returns and refunds
that can be applied to future purchases. You can also redeem the value from a gift card.
Store Credit
The order total is recalulated, and the amount of store credit that is applied appears in the
Order Summary.
Stored payment methods are available only for payment methods such as Braintree, that offer a
secure vault. When secure vault is enabled in the payment method configuration, customers
will have the option during checkout to save their credit card information as a stored payment
method. Customers can manage stored payment methods from their account dashboard.
Gift Card
The Gift Card section of your account dashboard can be used to check the balance of your gift
card account, and redeem gift cards for store credit.
Gift Card
Billing Agreements
Customers who enter into a billing agreement with a payment provider can make purchases
now and pay for them later, according to the agreement. To learn more, see: PayPal Billing
Agreements.
My Product Reviews
The My Product Reviews section of your account dashboard lists all the reviews that you have
submitted from the storefront. Each review summary includes the date the review was
submitted, and links to the product page, and review details.
My Product Reviews
Review Details
Newsletter Subscription
The Newsletter Subscription section of the account dashboard indicates if you are currently
subscribed to the general newsletter. Customers can sign up to receive the company newsletter
from the footer of the store. If the store doesn’t currently publish a newsletter, it can build a
subscription list for a future publication.
Newsletter Subscription
Customer Groups
2. Tap Filters .
3. Enter criteria for searching groups, including a range of IDs, group, or tax class.
Filtering Options
4. When complete, tap Apply Filters. The subset of filtered customer groups and members
displays.
a. Enter a unique Group Name less than 32 characters to identify the group.
Group Information
2. Find the customer in the list, and mark the checkbox in the first column.
Magento eBooks
Customer Segmentation
Learn how to increase profits and overall customer
satisfaction. Get the eBook now!
Segmentation Tactics
Improve the targeting of your messages and promotions
to create meaningful conversations with your customers.
Get the eBook now!
ATTRIBUTE DESCRIPTION
Customer Address Fields You can define any of the address fields, such as city or country. Any
address in a customer’s address book can match these conditions for
the customer to match. Or, you can specify that only the default
billing or shipping addresses can be used to match a customer.
Customer address attributes are available only for customers who
are logged in to their accounts.
Cart Fields Cart properties can be based on either quantity (line items or total
quantity) or the value (grand total, tax, gift card, etc.) of the cart
contents.
Products You can reference products that are currently in the shopping cart or
wish list, or that have previously been viewed or ordered. You can
also set a date range for when this occurred. The products are
defined using product attributes.
Order Fields Order characteristics for past orders can be defined based on the
billing/shipping address in the order, the total or average amount or
quantity of the orders, or the total number of orders. You can also set
a date range for when this occurred, and the order status of the orders
that match these conditions. Available only for customers who are
logged in. Conditions that are set for shoppers who are not logged in
stop working when they log in.
Customer Segments
Process Overview:
Step 1: Enable Customer Segments
Step 2: Complete the General Setup
Step 3: Describe the Conditions
Step 4: Generate the List of Matched Customers
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
Customer Segments
New Segment
a. Enter a Segment Name to identify the customer segment when working in the Admin.
c. Set Assigned to Website to the website where the customer segment can be used.
e. To identify the customers that this segment applies to, set the Apply to field to one of the
following:
l Registered Customers
l Visitors
4. When complete, tap Save and Continue Edit. Additional options become available in the
Segment Information panel.
Segment Information
1. In the panel on the left, choose Conditions. The condition begins, “If ALL of these conditions
are TRUE:”
Conditions
a. Tap Add ( ) to display the list of conditions. Then, in the list under Customer, choose
Date Of Birth.
b. In the condition after “Customer Date of Birth,” click the is link. Then, choose “equals or
greater than.”
c. Click the default date value, and replace with the following: “1977-01-01”. Then, click the
green checkmark ( ) to save the setting.
Condition Line 1
d. On the next line, click Add ( ). Then, in the list under Customers, again select Date of
Birth.
f. Replace the inserted date with the following: “1994-12-31”. Then, click the green
checkmark ( ) to save the setting.
1. In the panel on the left, select Matched Customers to display all customers who match the
condition.
Matched Customers(1)
The customer segment can now be used for targeting promotions, content, and mailings.
Field Descriptions
FIELD DESCRIPTION
Segment Name A name that identifies the segment for internal reference.
Description A brief description that explains the purpose of the segment for
internal reference.
Assigned to Website The single website where the segment can be used.
Status Activates and deactivates the segment. Any associated price rules
and banners are deactivated when the segment is disabled. Options
include: Active / Inactive.
Apply to Defines the customer types to which the segment is applied. The
selection influences the set of conditions available for creating the
segment. The setting cannot be changed after the segment is saved.
Options include:
3. Scroll down and expand the Conditions section. Then, complete the condition as follows:
a. Tap Add ( ) to display the list of conditions. Then, choose Customer Segment.
Customer Segment
b. By default, the condition is set to find a matching condition. If needed, click the matches
link, and change the operator to one of the following:
l is one of
l is not one of
Condition Operators
c. To target a specific segment, click the ( … ) “more” link to display additional options.
Then, click the Chooser ( ) to display the list of customer segments.
Chooser
d. In the list, mark the checkbox of each segment that you want to target with the condition.
4. Click Select ( ) to place the selected customer segments into the condition.
Banners
2. Set Customer Segments to “Specified.” Then in the list, select each customer segment that you
want to target with the banner.
3. In the panel on the left, choose Related Promotions. Then, mark the checkbox of each related
promotion.
Related Promotions
1631
Contents Orders Workspace
Order Actions
In this section of the guide, you’ll learn how to Order Search
manage all apsects of the order process, Grid Layout
including point of purchase support, order Order Workflow
processing, payments, and fulfillment.
Processing Orders
Sales Menu Order Status
Order Status Workflow
Point of Purchase Custom Order Status
Cart Scheduled Operations
Cart Configuration Pending Payment Order Lifetime
Cart Sidebar Scheduled Grid Updates
Redirect to Cart Order Archive
Quote Lifetime Invoices
Minimum Order Amount Creating an Invoice
Allow Reorders Printing Invoices
Order by SKU Shipments
Cart Thumbnails Credit Memos
Gift Options Product Return Workflow
Gift Wrap Issuing a Credit Memo
Gift Options Tax Printing Credit Memos
Persistent Cart Store Credit
Persistent Cart Workflow Store Credit Workflow
Conguring a Persistent Cart Applying Store Credit
Shopping Assistance Configuring Store Credit
Managing a Shopping Cart Refunds to Customer Account
Creating an Order Returns
Updating an Order RMA Workflow
Checkout Configuring Returns
Checkout Step 1 Returns Attribute
Checkout Step 2 Billing Agreements
Order Confirmation Transactions
Order Receipt
Payments
Checkout Configuration
Checkout Options Shipping
Checkout Totals Sort Order
Terms and Conditions
One Page Checkout
Orders
Orders
1632
CHAPTER 76:
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.
Sales Menu
Menu Options
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.
Dispatches
For Magento Shipping, lists shipments that are ready for
pickup per carrier.
Batches
For Magento Shipping, create batches of shipments that
can be booked together.
Returns
A returned merchandise authorization (RMA) can be
granted to customers who request to return an item for
replacement or refund. RMAs can be issued for Simple,
Grouped, Configurable, and Bundle product types.
However, RMAs are not available for virtual and
downloadable products, or gift cards.
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.
Archive
Archiving orders and other sales documents on a regular
basis improves performance and keeps your workspace
free of unnecessary information.
1636
Contents
Instant Purchase
Magento reduces ordering errors by automatically
verifying the SKU and availability of all items Cart
before an order is submitted. In this section of the Cart Configuration
guide, you’ll learn how to configure the cart and
Cart Sidebar
checkout options, and offer assistance to your
Redirect to Cart
customers.
Quote Lifetime
Minimum Order Amount
Allow Reorders
Order by SKU
Cart Thumbnails
Gift Options
Gift Wrap
Gift Options Tax
Persistent Cart
Persistent Cart Workflow
Conguring a Persistent Cart
Shopping Assistance
Managing a Shopping Cart
Creating an Order
Updating an Order
1637
CHAPTER 77: Instant Purchase
CHAPTER 77:
Instant Purchase
Instant Purchase allows customers to speed through the checkout process using information
that is saved in their account. When enabled, the Instant Purchase button appears below the
Add to Cart button on the product page for customers who meet the requirements.
Instant Purchase
Customer Requirements
Customers are signed in to their accounts.
At least one shipping method is available for the country that is specified in the default
shipping address.
Customer accounts have a stored payment method with vault enabled. The following
payment methods can be used to provide secure access to saved credit card information:
Braintree Credit Cards*
Braintree with PayPal Enabled
PayPal Payflow Pro
*Instant Purchase cannot be used with Braintree Credit Cards if 3D Secure is enabled.
3. Review the Instant Purchase Confirmation information. Then, tap OK to complete the
transaction.
A confirmation message and order number appears at the top of the product page.
1. On the Admin sidebar, choose Stores. Then under Settings, choose Configuration. Then, do
the following:
2. In the Braintree section under Recommended Solutions, tap Configure. Then, do the
following:
Configure Braintree
a. In the Basic Braintree Settings section, enter the following information from your
Braintree seller account:
l Merchant ID
l Public Key
l Private Key
b. Enter the Button Text that you want to appear on the button.
The button text can be changed for each store view, or language. By default, the
button text is “Instant Purchase.”
Instant Purchase
3. In the message at the top of the page, click Cache Management. Then in the upper-right
corner, tap Flush Magento Cache.
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 My Cart Link
l Cart Sidebar
l Redirect to Cart
l Quote Lifetime
l Cart Thumbnails
See also:
Checkout 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 Shopping Cart Sidebar is enabled, you can click the
link to display more detail.
Cart Link
My Cart Link
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.
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.
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.
Redirect to 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.
4. In the Quote Lifetime (days) field, enter the number of days that a quoted price remains valid.
Shopping Cart
b. Enter the Minimum Amount that is required for the subtotal, after discounts are applied.
Yes Requires the subtotal to meet the minimum amount with tax included.
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.
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.
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.
Reorder
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.
Shopping Cart
Order by SKU
Order by SKU is a widget that can be displayed in the store as a convenience for all shoppers,
or made available to only those in specific customer groups. Shoppers can either enter the SKU
and quantity information directly into the Order by SKU block, or upload a csv file from their
customer account. Regardless of the configuration, Order by SKU is always available to store
administrators.
1. In the Order by SKU block, enter the SKU and Qty of the item to be ordered.
2. To add another item, click Add Row, and repeat the process.
b. To add another item, tap Add Row , and repeat for as many items as necessary.
a. Prepare a CSV file that includes columns for SKU and Qty.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configure.
Yes, for Everyone The Order by SKU block is available in the store for every shopper.
Yes, for Specified Order by SKU is available only to members of a specific customer group,
Customer Groups such as “Wholesale.”
No The Order by SKU block does not appear in the storefront, and the Order
by SKU page is not available in the customer account.
Gift Options
The selection of available gift options appears in the cart before the checkout process begins.
The Gift Options configuration determines if customers can add a gift message or greeting card,
and the gift wrapping that are available. Each item in the order can have a separate message
and gift wrapping. When applied to the entire order, a gift receipt and greeting card can be
added, as well. The Gift Options configuration applies to the entire website, but can be
overridden at the product level.
2. In the panel on the left, under Sales, choose Sales. Then, expand the Gift Options section.
Gift Options
5. To give customers the option to include a gift receipt with their orders, set Allow Gift Receipt
to “Yes.”
6. To give customers the option to include a printed card with their orders, set Allow Printed
Card to “Yes.” Then, enter the Default Price for Printed Card.
Gift Wrap
Gift wrapping is available for any product that can be shipped, and can be offered for
individual items or for the entire order. You can charge a separate price for each gift wrap
design, and upload a thumbnail image of the design that appears as an option for the product
in the cart. When the gift wrap thumbnail is clicked, a full-size image appears. During checkout
review, the gift wrap charge appears with the other checkout totals in the Order Summary
section.
The gift wrap image should be a swatch that shows the repeating pattern, and can also include
a sample of the ribbon that is to be used. You can either scan the paper, or take a photograph
of a wrapped package. The uploaded image can be GIF, JPG, or PNG image, and should be
square. .In the following example, the uploaded gift wrap image is 230 x 230 pixels.
1. On the Admin sidebar, tap Stores. Then under Other Settings, choose Gift Wrapping.
Gift Wrapping
2. In the upper-right corner, tap Add Gift Wrapping. Then, do the following:
a. Enter the name for the Gift Wrapping Design to appear during checkout.
b. Select the Websites where the gift wrap design will be available.
e. To upload a thumbnail Image of the gift wrapping, tap Choose File. Then, select the file to
upload from your directory. A thumbnail of the image appears in the Gift Wrapping
Information after the record is saved.
1. On the Admin sidebar, tap Stores. Then under Other Settings, choose Gift Wrapping.
2. Find the gift wrap record in the list. Then in the Action column, click Edit.
2. At the top of the workspace, tap Delete. Then when prompted, tap OK to confirm.
3. Tap Submit.
Field Descriptions
FIELD SCOPE DESCRIPTION
Gift Wrapping Design Store View The name of the gift wrap option that appears to
customers during checkout. The name can be
different for each store view.
Websites Select the websites where the new gift wrap will be
available.
Price Global Specifies the price of the gift wrap option. This setting
can be overridden by the gift wrap price set at the
product level.
Image Global Uploads a thumbnail image of the gift wrap design that
appears next to the gift wrap option.
3. Expand the Tax Classes section. Then, set Tax Class for Gift Options to the applicable tax
class.
Tax Classes
4. Expand the Orders, Invoices, Credit Memos Display Settings section. Then, do the
following:
l Excluding Tax
l Including Tax
l Excluding Tax
l Including Tax
Persistent 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.
When using a persistent cart, it is recommended that you set the lifetime of the server session
and the session cookie to a long period of time. To learn more, see: Customer Session Lifetime.
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.
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.”
Remember Me
Customers can click the “Remember Me” checkbox on the Login page to save the contents of the
their shopping carts.
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.
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.
Enable Remember Me = “Yes” When a customer logs in, both cookies are
Clear Persistence on Log Out = “Yes” applied. When a customer logs out, both cookies
are deleted. If a customer does not log in, but the
Remember Me = “Yes”
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.
Enable Remember Me = “Yes” When a customer logs in, both cookies are
Clear Persistence on Log Out = “No” applied. When a customer logs out, the session
cookie is deleted, the persistent session
Remember Me = “Yes”
continues. The persistent cookie is deleted when
its lifetime runs out or when the customer clicks
the Not %Jane Smith% link.
If the session cookie expires while the customer is logged in, the persistent cookie remains active.
2. In the panel on the left under Customers, choose Persistent Shopping Cart.
4. To enable the persistent shopping cart and display additional options, set Enable Persistence
to “Yes.” Then, do the following:
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.
Yes Displays the “Remember Me” checkbox on the Login page of your store, so
customers can choose to save their shopping cart information.
No 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.”
Yes The shopping cart is cleared when a registered customer logs out.
If the session cookie expires while the customer is still logged in, the persistent cookie remains
in use.
Yes 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.
No The shopping cart is not preserved for guests after the session cookie
expires.
l Creating Orders
Shopping Cart
All visitors to the store and logged in customers appear in the list.
2. In the list, open the customer record in edit mode. To find the customer record in a hurry, use
the Filters control.
In the customer profile under Personal Information, the Last Logged In date and time shows
that the customer is currently online.
3. In the button bar across the top of the page, tap Manage Shopping Cart to enter assisted
shopping mode.
2. To find a product, use any of the filters at the top of each column. Then, tap Search.
The line item is added to the Shopping Cart at the top of the page.
Cart Updated
Configure
2. Under Associated Products, choose each product option to describe the item to be
ordered. Then, enter the Quantity.
3. Click OK.
Choose Options
The product is selected with a checkmark, and the quantity ordered appears in the grid.
1. Expand the Add to Shopping Cart by SKU section. Then, use of the following
methods to add products to your cart.
d. If the item is a configurable product, choose the product options when prompted.
Then, tap Add to Shopping Cart.
l Wish List
2. In the grid, select each product to be ordered. and enter the Quantity.
3. To enter the options for a configurable product, tap Configure. Then, follow the
instructions in Method 1 to choose each product option.
a. In the Qty column of the product to be adjusted, enter the correct amount.
The Create New Order page shows the items in the cart, followed by the shipping and payment
information.
8. Complete the shipping and payment information, and tap Submit Order. To learn more, see:
Creating an Order.
Creating an 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.
2. Find the customer in the grid. Then in the Action column, click Edit.
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.
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.
Select Products
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
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
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.
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.
l To save changes made to line items, and reprocess the order, tap Submit Order.
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.
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:
3. Tap Cancel.
Cancel Order
The status of the order is now “Canceled.”
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.
The format of the street address for the recipient and sender is determined by the properties of
the customer address attribute. The input validation setting determines the valid characters
that can be used in a shipping address.
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.
1. If there are additional entries in the address book, find the address where the order is to be
shipped.
By default, the customer’s first and last names initially appear in the form.
Shipping Address
3. To save the new address in the address book, mark the checkbox at the bottom of the form.
1. In the list of shipping methods, choose the option that you want to use.
Shipping Methods
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
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 Guest Checkout
l Gift Options
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.
Checkout Options
Guest Checkout
Your store can be configured to require shoppers to open an account before making a purchase.
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
4. If necessary, clear the Use system value checkbox. Then, do the following:
Checkout Options
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
Checkout Options
1. On the Admin sidebar, tap Stores. Then under Settings, choose Terms and Conditions.
New Condition
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.
Checkout Options
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.
Checkout Totals
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.
5. Change the number assigned to each item to determine its order in the Totals section..
1699
Contents Credit Memos
Product Return Workflow
In this section of the guide, you will learn about Issuing a Credit Memo
each stage of the order workflow, and how to Printing Credit Memos
process orders, create invoices, and shipments.
Store Credit
You will also learn how to issue credit memos and
Store Credit Workflow
manage returns.
Applying Store Credit
Orders Configuring Store Credit
Order Workspace Refunds to Customer Account
Order Actions Returns
Order Search RMA Workflow
Grid Layout Configuring Returns
Order Workflow Returns Attribute
Processing Orders Billing Agreements
Order Status Transactions
Order Status Workflow
Custom Order Status Archive
Order Status Notification
Scheduled Operations
Pending Payment Order Lifetime
Scheduled Grid Updates
Order Archive
Invoices
Creating an Invoice
Printing Multiple Invoices
Shipments
1700
CHAPTER 81:
Orders
The Orders workspace lists all current orders in descending order from latest purchase date.
Each row in the grid represents an order, and each column represents an attribute, or data
field. By default, orders display in descending order from latest to earliest purchase date. Use
the standard controls to sort and filter the list, find orders, and apply actions to selected
orders. You can view existing orders, and create new orders. The tabs above the pagination
controls can be used to filter the list, change the default view, change and rearrange columns,
and export data.
Orders
Order Workspace
The Order workspace lists all current orders. Each row in the grid represents a customer order,
and each column represents an attribute, or data field . Use the standard controls to sort and
filter the list, find orders, and apply actions to selected orders. From the grid, you can view
existing orders, and create new orders. The tabs above the pagination controls are used to filter
the list, change the default view, change and rearrange columns, and export data.
Orders
Workspace Controls
CONTROL DESCRIPTION
Filters Defines a set of search parameters that determines the records that
appear in the grid.
Columns Determines the selection of columns and their order in the grid. The
column layout can be changed. and saved as a “view.” By default,
only some of the columns are included in the grid.
Column Descriptions
COLUMN DESCRIPTION
Select Mark the checkbox to select the quote(s) to be subject to an action,
or use the selection control in the column header. Options: Select All
/ Deselect All
Purchase Point Identifies the store view where the order was placed.
Bill-to Name The name of the person who is responsible to pay for the order.
Ship-to Name The name of the person to whom the order is to be shipped.
Grand Total (Purchased) The grand total of products purchased in the order.
Signifyd Guarantee If enabled, Signifyd automatically reviews your orders for fraud, and
Decision indicates which orders to ship, and which to reject.
Billing Address The billing address of the customer who placed the order.
Customer Email The email address of the person who placed the order.
Customer Group The customer group to which the person who placed the order is
assigned.
Subtotal The order subtotal, without shipping and handling, and tax.
Shipping and Handling The amount charged for shipping and handling.
Customer Name The first and last name of the customer who placed the order.
Total Refunded Any amount from the order that is to be refunded to the customer.
Refunded to Store Credit Any amount from the order that is to be refunded to the customer’s
store credit.
Order Actions
To apply an action to specific orders, mark the checkbox in the first column of each order. To
select or deselect all orders, use the control at the top of the column.
Order Actions
Action Controls
CONTROL DESCRIPTION
Actions 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
Print Shipping Labels
Move to Archive
Batch Process
Mass Actions Can be used to select multiple records as the target of action. Mark
the checkbox in the first column of each record that is subject to the
action. Options:
Select All / Unselect All,
Select Visible / Unselect Visible
CONTROL DESCRIPTION
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
2. Complete as many of the filters as needed to describe the order(s) that you want to find.
Order Filters
Search Filters
FILTER DESCRIPTION
ID Filters the search based on order ID.
Bill-to Name Filters the search by the name of the person who is responsible to
pay for the order.
Ship-to Name Filters the search by the name of the person to whom each order is
shipped .
Purchase Point Filters the search by website, store, or store view where the order
was placed.
Purchase Date Filters the search based on the date purchased. To find orders within
a range of dates, enter both the From and To dates.
Grand Total (Base) Filters the search based on the Grand Total of each order.
Grand Total (Purchased) Filters the search based on Grand Total of items purchased in each
order.
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:
2. Enter a name for the view. Then, click the arrow ( ) to save all changes.
l To change the name of a view, tap the Edit ( ) icon. Then, update the name.
Order Workflow
When a customer places an order, a sales order is created as a temporary record of the
transaction. In the Orders grid, sales orders initially have a status of "Pending," and can be
canceled at any time until the payment is processed. After payment is confirmed, the order can
be invoiced and shipped.
Place Order. The checkout process begins when the shopper clicks the Go to Checkout
button on the shopping cart page or reorders directly from their customer account.
Order Pending. In the Orders grid, the status of the sales order is initially “Pending.”
Payment has not been processed, and the order can still be edited or 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.
Book a Single Shipment. When the shipment detail is complete, the shipment is
booked, 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.
Book a Batch of Shipments. (Magento Shipping only) Enter and process the shipment
information for multiple orders as a batch.
Create a Dispatch. (Magento Shipping only) Create a dispatch that lists the packages
that are ready for pickup, and print the manifest.
Processing an Order
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 edited while pending, and can be canceled up until the time that 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
To view an order:
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.
The panel on the left of an open order provides access to different types of information that is
related to the order.
View Order
To process an order:
1. To open a pending sales order, and tap the Edit button in the upper-right corner.
Orders can be edited only while the status is “Pending”. The Edit button isn’t visible for orders that
are “Processing” .
2. Review the following sections in the sales order, using the field descriptions for reference.
Address Information
Address Information
Items Ordered
Items Ordered
b. If you want to email the comment to the customer, mark the Notify Customer by Email
checkbox.
c. If you want the comment to be visible in the customer account, mark the Visible on
Storefront checkbox.
Order Total
4. If you are ready to invoice the order, tap Invoice. Then follow the instructions to Creating an
Invoice
Shipments Lists each shipment record that is associated with the order.
Comments History Lists all notes that are related to the order.
Button Bar
BUTTON DESCRIPTION
Back Returns to the Orders page without saving changes.
Hold / Unhold Changes the status of the sales order to “On Hold”. To release the
hold on the sales order, choose “Unhold”.
Invoice Creates an invoice from the sales order by converting the order to an
invoice.
Edit Opens a pending order in edit mode. The Edit button isn’t visible for
orders with a status of “Processing”.
Field Descriptions
FIELD DESCRIPTION
Order Number The order number appears at the top of the sales order, and also in
the Order & Account Information, followed by a note that indicates if
the confirmation email was sent.
Order Date The date and time the order was placed.
Purchased From Indicates the website, store, and store view where the order was
placed.
Placed from IP Indicates the IP address of the computer from which the order was
placed.
Customer Name The name of the customerwho placed the order. The Customer Name
is linked to the customer profile.
Email The email address of the customer. The email address is linked to
open a new email message.
Customer Group The name of the customer group to which the customer is assigned.
ADDRESS INFORMATION
Billing Address The name of the customer who placed the order, followed by the
billing address, telephone number and VAT, if applicable. The
telephone number is linked to autodial on a mobile device.
Shipping Address The name of the person to whose attention the order should be
shipped, followed by the shipping address and telephone number.
The telephone number is linked to autodial on a mobile device.
Payment Information The method of payment to be used for the order, and purchase order
number, if applicable, followed by the currency that was used to
place the order.
Shipping & Handling The shipping method to be used, and any handling fee that is
Information applicable.
ITEMS ORDERED
Original Price The original catalog price of the item before discounts.
Tax Amount The amount of tax that applies to the item as a decimal value.
Row Total The line item total, including applicable taxes that are due at the
product level, less discounts.
ORDER TOTAL
Comment A text box that is used to enter a comment to the customer that
accompanies the order.
Order Totals
Shipping & Handling The amount charged for shipping and handling fees.
Store Credit The amount of available store credit that is applied to the order, if
appliable.
Total Paid The total amount paid toward the order, if applicable.
Total Refunded The total amount refunded from the order, if applicable.
Order Status
All orders have an order status that is associated with a stage in the order processing workflow.
The status of each order is shown in the Status column of the Orders grid. Your store has a set
of predefined order status and order state settings. The order state describes the position of an
order in the workflow.
Order Status
Pending pending
On Hold holded
Open STATE_OPEN
Complete complete
Closed closed
Canceled canceled
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.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Order Status.
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.
Assign Status
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.
1. In the Order Status grid, open the status record in edit mode.
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.
Pending pending
On Hold holded
Complete complete
Closed closed
Canceled canceled
4. In the Pending Payment Order Lifetime (minutes) field, enter the number of minutes before a
pending payment expires.
l Orders
l Invoices
l Shipments
l Credit Memos
The benefits of scheduling these tasks is to avoid the locks that occur when data is saved, and
to reduce processing time. When enabled, any updates take place only during the scheduled
cron job. For best results, Cron should be configured to run once every minute.
Grid Settings
PDF Invoice
Creating an Invoice
Creating an invoice for an order converts the temporary sales order into a permanent record of
the order that cannot be canceled. A new invoice page looks similar to a completed order, with
some additional fields. Every activity that is related to an order is noted in the Comments
section of the invoice.
Normally, orders are invoiced and shipped after payment is received. However, if the method of
payment is a purchase order, the order can be invoiced and shipped before payment is received.
You can generate an invoice with a packing slip, and also print shipping labels from your
carrier account. A single order can be divided into partial shipments which are invoiced
separately, if necessary.
When the state of new orders is set to “Processing,” the option to “Automatically Invoice All
Items” becomes available in the configuration. Some credit card payment methods complete the
invoicing step as part of the process when Payment Action is set to “Authorize and Capture.” In
such a case, the Invoice button does not appear, and the order is ready to ship.
Before an invoice can be printed, it must first be generated for the order. To view or print the
PDF, first download and install a PDF reader such as Adobe Acrobat Reader.
Invoices
To invoice an order:
1. On the Admin sidebar, tap Sales. Then under Operations, choose Orders.
2. Find the sales order with the status of “Processing” in the grid. Then, do the following:
b. In the header of the sales order, choose the Invoice option. The new invoice page looks
similar to a completed order page, with additional fields that can be edited.
The Invoice option does not appear if the payment method is set to “Authorize and Capture.”
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
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.
Items to Invoice
4. If an online payment method was used for the order, set Amount to the appropriate option.
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."
Completed Invoice
1. At the top of the workspace, tap Print to generate a PDF of the invoice
Payment Actions
PAYMENT ACTION DESCRIPTION
Capture Online When the invoice is submitted, the system captures the payment
from the third-party payment gateway. You have the ability to create
a credit memo and void the invoice.
Capture Offline When the invoice is submitted, the system does not capture the
payment. It is assumed that the payment is captured directly through
the gateway, and you no longer have the option to capture this
payment through Magento. You have the ability to create a credit
memo, but you do not have the option to void the invoice. (Even
though the order used an online payment, the invoice is essentially an
offline invoice.)
Not Capture When the invoice is submitted, the system does not capture the
payment. It is assumed that you will capture the payment through
Magento at a later date. There is a Capture button in the completed
invoice. Before capturing, you are able to cancel the invoice. After
capturing you are able to create a credit memo and void the invoice.
Do not select Not Capture unless you are certain that you are going
to capture the payment through Magento at a later date. You will not
be able to create a credit memo until the payment has been captured
using the Capture button.
To view or print the PDF, you must have a PDF reader. You can download Adobe Reader at no
charge.
Print Invoices
The invoices are saved in a single PDF file that can be sent to a printer, or saved.
Magento supports partial and complete order shipment, with additional options depending on
Inventory Management, Magento Shipping, and third party extensions.
Shipments
Shipment Workflow
The value of the Status column in the Shipments grid reflects the state of the shipment as it
moves through the workflow. If the Status column isn’t currently visible in the Shipments grid,
you can change the grid layout to include the column. Then, use the grid controls to filter the
shipments by status.
Shipment is dispatched.
Shipment canceled.
Shipment Status
STATUS DESCRIPTION
Pending A quote has been generated for the shipment, but it is not yet booked
with a carrier.
Fulfilled A booking has been made for the shipment, and it is ready for
dispatch.
Creating a Shipment
The following instructions walk you through the process of creating a shipment for Magento
Shipping. If you have Inventory Management enabled, you may want to review Creating
Shipments with Inventory Management.
To create a shipment:
1. On the Admin sidebar, choose Sales. Then, choose Orders.
3. If the order has been paid and invoiced, and is ready to ship, tap Ship.
The sections at the top of the shipment contain name and address and payment information
from the sales order.
If you have Inventory Management enabled, select a source (or location) and an amount of
quantity to send per line item. For complete details, see Creating Shipments with Inventory
Management.
Items Ordered
For each line item in the order, enter the Qty Packed.
Items Ordered
Enter a Shipment Reference number to identify the shipment on the customer manifest and
shipping labels. The default value is the Magento Customer ID, but can be any other value up
to 15 characters.
Route Information
For Magento Shipping, the default location is entered automatically, but can be overridden
as necessary.
For international shipments, the International Item Details and International Shipment
Details sections appear in the form.
Route Information
Packages
In the catalog database, make sure that the weight is entered correctly for all products to be
shipped. If using Magento Shipping, also complete the packaging seup, as needed.
Magento Shipping presents a list of predefined carrier packaging after the carrier connects. The
list includes all package types offered by the carrier, and the pricing and associated services are
updated automatically from the carrier.
The package configuration grid lists only merchant-defined packaging. Carrier-specific packaging
does not appear in the grid.
After you choose a package type, the length, width, height, and dimension unit are
automatically entered, or “pre-filled.” The following determinations are made to calculate the
package weight:
l The weight of the package, as specified in the catalog for each shippable product.
l The sum of all product weights in the package, as well as the tare weight of the package.
An error occurs if the weight of all items in the package exceeds the maximum weight allowed
for the package. The total weight is recalculated whenever the package type or quantity ordered
changes. A warning appears below the Total Weight field, as a reminder to verify the values
and make any changes necessary.
l If you choose a prepared package type profile, the measurements are entered
automatically.
l If you choose a Custom package, you must enter the Length, Width, and Height of the
package. Then in the Dim. Units field, enter the number of dimensional units used by
the package in the delivery vehicle or container.
2. Enter the Weight of the package. If necessary, set the Weight Units field to a different unit
of measurement that is used for weight.
3. The Contents field displays the value of the Quantity Packed field under Items Ordered.
To change the number of ordered items that are packed in the shipment, enter the
updated value in the Contents field. The Quantity Packed value reflects the change.
Packages
4. To add another package to the shipment, do the following:
Complete the fields in the International Item Details section. If you need help, click the Help (
) button, or refer to the Field Descriptions at the end of this topic.
Complete the fields in the International Shipment Details section. If you need help, click the
Help ( ) button, or refer to the Field Descriptions at the end of this topic.
Add-Ons
The selection of value-added delivery options is determined by shipping method and carrier.
Some orders shipped with Magento Shipping might have additional options.
1. To give the carrier permission to leave the delivery unattended, mark the Unattended
Delivery checkbox.
2. To require the carrier to obtain a signature for the delivery, mark the Signature Required
checkbox.
3. (Magento Shipping UPS - US only) If available and applicable, mark the Adult Signature
Required checkbox.
4. (Magento Shipping UPS - US only) If you want to prevent the delivery from being
redirected or rerouted by the recipient or driver, choose Direct Delivery Only.
5. (Magento Shipping UPS - US only) If needed for a time-critical delivery, mark the
Saturday Delivery checkbox.
6. To identify the type of address, set Destination Address Type to one of the following:
l Business
l Residential
Add-Ons
Shipping Quotes
l To use the customer’s preferred method of shipping, mark the Customer Preference
checkbox.
l To override the customer’s preferred method, clear the Customer Preference checkbox.
Then, choose another method.
The Book Shipment button in the header is now active. and the Shipping and Tracking
Information is completed for the carrier.
Shipping Quotes
Shipping Comments
Enter Comments for the shipment, if needed.
Shipping Comments
5. When the shipment is ready, tap Book Shipment. Then, do the following:
Tracking Information
b. To send the package tracking information to the customer, tap Send Tracking Information.
6. A message appears at the top of the page that the shipment has been sent, and the
Documentation section appears in the shipment form, with a list of available printouts. The
following example includes the High Value Report, which is available for Magento Shipping
orders over $999.00 (UPS - US only).
a. In the Action column, click the link to Download the package label for the shipment.
Then, Print the label.
Documentation
b. (Magento Shipping only) To print the High Value Report, click the Download link. Then,
look for the text/html file in your browser’s download list.
7. To print a packing slip for this shipment, click Print in the page header. Look for the PDF file
in your browser’s download list.
Button Bar
FIELD DESCRIPTION
Back Closes the New Shipment form, and returns to the order
Field Descriptions
FIELD DESCRIPTION
SHIPPING INFORMATION
ADDITIONAL INFORMATION
Shipment Reference (Magento Shipping only) Associates bookings between a carrier and
a customer, and appears on shipping labels, manifest, and carrier
Electronic Data Interchange (EDI) file, if applicable. The default value
is the Magento Customer ID, and can be edited if required.
Maximum length: 15 (upper- and lowercase characters, numbers 0-9)
ROUTE INFORMATION
ITEMS ORDERED
PACKAGES
Dim. Units The number of dimensional units used by the package in the delivery
vehicle or container.
Weight Units The unit of measurement used to describe the package weight.
Country of Manufacture The country where the items in the shipment were manufactured.
Signatory Title The prefix of the name of the person who is authorized to sign for
receipt of delivery.
Signatory First Name The First Name of the person who is authorized to sign for receipt of
delivery.
Signatory Last Name The Last Name of the person who is authorized to sign for receipt of
delivery.
International Commerce The code for the International Chamber of Commerce rule that
Terms (Incoterms) applies to this shipment.
Export Category The export category that applies to the shipment. Options:
Commercial
ADD-ONS
Unattended Delivery Indicates if the carrier can leave the package unattended at the
destination address.
Adult Signature Required (Magento Shipping UPS - US only) Indicates if an adult signature is
required.
Saturday Delivery (Magento Shipping UPS - US only) Indicates that the package can be
delivered Monday through Saturday. When this option is chosen, only
services that support Saturday delivery are listed.
SHIPPING QUOTES
Quote from Shipping Use To override the default setting, clear the
Experience customer’s checkbox, and choose the type of quote.
choice
SHIPMENT COMMENTS
DOCUMENTATION
Canceling a Shipment
Before a shipment is dispatched to a carrier, it can be canceled by opening the order and
navigating to the shipment, provided the carrier supports cancellations. Some carriers restrict
or limit cancellations after a booking. For example, UPS allows cancellations, but requires that
you wait 24 hours after the shipment is booked. If a shipment is canceled, the cancellation
cannot be reversed. The only recourse is to recreate the order.
To cancel a shipment:
1. On the Admin menu, choose Sales.
2. Find the order in the grid. Then in the Action column, choose View.
If the shipment can be canceled, a Cancel Shipment button appears in the button bar.
If the carrier does not support cancellations, an error message appears that explains why the
shipment couldn’t be canceled.
Dispatches
If Magento Shipping is enabled, the Dispatches grid lists all shipments that are ready to ship.
For each scheduled pickup, you can create a Dispatch and printed manifest that includes each
package that is to be included, per carrier.
Dispatches
To create a dispatch:
b. Choose the Location where the packages in the manifest are to be picked up. Then, tap
Next.
3. To set the date and time of the scheduled pick up, do the following.
Dispatch Date
b. Click the Time below the calendar, and choose the scheduled time of the pickup.
Dispatch Time
1. Find the dispatch in the grid. Then in the Action column, click View.
Dispatch Information
2. If a problem is encountered while communicating with the carrier, the report will include a
failed shipment. Click Find Solutions for more information.
In this case, the problem was caused by a missing or invalid postal code in our sample data.
Find a Solution
Batches
Batch processing allows you to process a large number of shipments in a fraction of the time it
would take to process the shipments manually. Unlike the standard process to create a
shipment, the batch process leverages the Temando API, which is synchronized to your
Magento installation.
The Batches grid lists the available Magento Shipping batches, the number of shipments in
each, and their status. You can view the detail of a single batch, print packing slips, and
shipping labels. The grid at the bottom of the page lists the shipments in the batch.
Batches
2. Find the batch in the list. Then in the Actions column, click View.
Batch Detail
3. To print packing slips for each shipment in the batch, click Print All Packing Slips.
b. Look for the ZIP file of labels in your browser’s list of downloads.
c. Click the download file to view the individual PNG files. Then, open and print each label.
Shipping Label
Column Descriptions
COLUMN DESCRIPTION
Created At The date and time the batch was created.
No. of Shipments Booked The number of shipments in the batch that booked properly.
Successfully
Creating a Batch
Orders that are ready to ship with Magento Shipping can be booked together as multiple
shipments, and processed as a batch. Each shipment includes a detailed description of the
package(s) to be included, with additional instructions for the carrier. The shipment is
processed according to the shipping experience rule of your choice. Documentation, including
shipping labels, is generated for each package, and is available for download.
1. In the Admin sidebar, choose Stores. Then under Shipping, choose Experiences.
3. Scroll down to the Batch Fulfillment Rules section. Then, tap Create Rule, and do the
following:
a. Enter a brief Description of the rule that states its purpose and the conditions that trigger
the rule.
b. Because this rule is to run every time, accept the default Condition value of “Always.”
Condition
Then, choose the carrier(s) and services that you want to use for fulfilling the orders in the
batch.
Outcome
1. On the Admin sidebar, choose Sales. Then choose Orders, and do the following:
a. In the Orders grid, mark the checkbox of each order that you want to include in the batch.
2. Follow the progress indicator at the top of the page, as you complete the following:
a. To complete Step 1, choose the Origin Location to establish where the orders to be
shipped are booked. Then in the upper-right corner, tap Next.
b. To complete Step 2, review the orders in the grid. If necessary, clear the checkmark of any
order that you do not want to include in the batch. Then, tap Next.
c. In Step 3, you will complete the detail information for each order in the batch.
The packaging of each item must be defined before the quoting and booking processes can
take place. The total weight is calculated based on the weight that is specified in the
product record. When a package type is specified, the calculated weight is updated to
include the weight of the packaging, if available.
d. This page is wider than most pages, and includes a section for each order in the batch. Do
the following to describe each package in each order:
e. To ship the order in multiple packages, click Add Another Package. Then, complete the
previous step to describe the additional package and its contents.
f. If you need to remove a package, click the Delete icon ( ) to the right of the Weight
Unit field.
Items in a removed package are not automatically restored to the previous package. In such a
case, it is necessary to update the Package Contents field manually, or add another package.
l Business
l Residential
b. Mark the checkbox of any additional delivery options that apply to the shipment.
c. To keep the workspace uncluttered, you can click Hide Details after you prepare each order
in the batch for booking.
The new batch appears at the top of the Batches grid, with the status, “Created.” In the grid,
the checkbox is marked for all orders that are to be included in the batch. To remove an order
from the batch, simple clear its checkbox. are marked with a checkbox.
Batch booking times can vary, depending on the quantity of bookings within a batch, and the
carriers used. The status of each batch in the list is updated automatically as batches are
booked. A batch can have has one of three possible states:
Processing Indicates that the shipments for the orders in the batch are still in
process, and the booking request is sent to the carrier.
Processed Indicates that the batch process has run the booking requests, and
response has been received from the carrier(s).
If an order was not successfully booked, it can be processed again during the standard
workflow, either individually, or as part of a batch.
New Batch
When a batch receives responses from all of the carriers regarding booking requests, the batch
booking request process ends, and the results of the shipment bookings appear in the list. If a
batch has shipments that failed to book, you can view the batch to investigate further.
1. In the Actions column, click View to examine the batch or to access the shipment
documentation.
2. Do one of the following to print the documentation associated with the batch:
All of the associated documentation is collated into a single file for you to print. Downloaded
documentation is saved as a compressed zip file, and each individual document is saved as a
.PNG file.
Step 4: Dispatch
The final step in the fulfillment process is to create a dispatch and printed manifest. To
continue, see: Dispatches.
Field Descriptions
FIELD DESCRIPTION
Package Contents The number of units from each line item that
are in the package.
Shipping Experience Determines the shipping experience rule that is to be used for the
shipment.
Error Messages
TYPE DESCRIPTION
Errors when orders are loaded for a batch
If a booking with a carrier fails, the reason for the failure must be
understood to ensure a successful booking next time.
To view the causes and identify possible solutions, first view the
batch. Then next to the number of failed shipmetns, click Find
Solutions.
The Find Solutions page describes the order that failed to book, and
provides the known reason for failure, or the error that was returned
by the platform or carrier.
The methods that are available to issue refunds depends on the payment method that was used
for the order. Orders that were placed using can be refunded to the respective account. Orders
that were paid by credit card through a payment gateway can be refunded online, by the
payment processor. Orders that were paid COD or by check or money order are refunded offline.
Credit Memos
If using Vertex Cloud, see the Vertex Settings configuration section for information about issuing
refunds for sales orders that are invoiced when the status is either “Suspected Fraud” or “Canceled.”
2. Find the completed order in the grid. Then in the Action column, click the View link to open
the order.
3. In the button bar at the top of the page, tap Credit Memo. (The button appears only after an
order is invoiced.)
Items to Refund
If an online payment method was used, you will not be able to edit these fields.
l If the product is to be returned to inventory, mark the Return to Stock checkbox. With
Magento Inventory Management enabled, the inventory quantity returns to the source that
sent the shipment.
l If the product will not be returned to inventory, leave the checkbox blank.
The Return to Stock checkbox appears only if inventory Stock Options are set to “Decrease Stock
When Order Is Placed.”
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.)
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.
Refund Totals
7. To complete the process and generate the credit memo, choose one of the following refund
option buttons, according to the payment type:
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.
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.
9. In the panel on the left, choose Credit Memos. Any credit memos that are associated with this
order appear in the list.
Field Descriptions
FIELD DESCRIPTION
Order Number The order number appears in the Order & Account Information,
followed by a note that indicates if the confirmation email was sent.
Order Date The date and time the order was placed.
Purchased From Indicates the website, store, and store view where the order was
placed.
Placed from IP Indicates the IP address of the computer from which the order was
placed.
Account Information
Customer Name The name of the customerwho placed the order. The Customer Name
is linked to the customer profile.
Email The email address of the customer. The email address is linked to
open a new email message.
Customer Group The name of the customer group to which the customer is assigned.
ADDRESS INFORMATION
Billing Address The name of the customer who placed the order, followed by the
billing address, telephone number and VAT, if applicable. The
telephone number is linked to autodial on a mobile device.
Shipping Address The name of the person to whose attention the order should be
shipped, followed by the shipping address and telephone number.
The telephone number is linked to autodial on a mobile device.
Payment Information The method of payment to be used for the order, and purchase order
number, if applicable, followed by the currency that was used to
place the order.
Shipping & Handling The shipping method to be used, and any handling fee that is
Information applicable.
ITEMS TO REFUND
Tax Amount The amount of tax that applies to the returned item as a decimal
value.
Tax Percent The percentage of tax applied to the returned item as a percentage.
Row Total The line item total, including applicable taxes that are due for the
returned product level, less discounts.
ORDER TOTAL
Comment Text A text box that is used to enter a comment to the customer about the
credit memo.
Refund Totals
Adjustment Refund An amount that is added to the total amount refunded as an additional
refund that does not apply to any particular part of the order, such as
shipping, items, or tax. The amount entered cannot raise the total
refund higher than the amount paid.
Adjustment Fee An amount that is subtracted from the total amount refunded, such as
a restocking fee, or an amount that is related to gift wrapping or gift
options.
Append Comments Checkbox that determines if comments are included in the credit
memo.
Email Copy of Credit Checkbox that determines if a copy of the credit memo is emailed.
Memo
Refund to Store Credit Checkbox that determines if the total is to be refunded to store credit.
REFUND BUTTONS
The payment method used for the order determines that refund buttons that are available for a
credit memo.
Refund Online If the original purchase was paid by credit card through a payment
gateway, the refund amount is managed by the payment processor.
To manage refunds, see the documentation provided by your
payment provider.
Refund Offline If the original purchase was paid by check or money order, the refund
is paid directly to the customer, by issuing a check, gift card, or cash
if you have a brick and mortar storefront. The credit memo serves as
a record of the offline transaction.
Credit Memos
2. Tap Print.
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.
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.
After an order is paid and invoiced, all of the order, or a portion of it, can be refunded by
issuing a credit memo. A credit memo differs from a refund because the amount of the credit is
restored to the customer’s account where it can be used for future purchases. In some cases, a
refund can be given at the same time that a credit memo is issued, and applied to the
customer’s balance of store credit. The amount of store credit that is available in the customer’s
account is specified in the configuration.
Customer Login. Customer logs into account before beginning the checkout process.
Use Store Credit. During the Review & Payments step of the checkout process, the
customer elects to “Use Store Credit” as a payment option. The available balance is
shown in parentheses If the available balance is greater than the order grand total, the
other payment methods disappear.
Credit Applied to Order. The amount of store credit that is applied to the order appears
with the order totals, and is subtracted from the grand total.
Customer Balance Adjusted. The customer’s available balance is adjusted when the
order is placed.
2. Find the customer In the grid. Then in the Action column, click Edit.
c. Set Store Credit Update Email Sender to the store identity that appears as the sender of
email notifications sent to customers.
d. Set Store Credit Update Email Template to the template that is used for email
notifications sent to customers.
Refund Detail
l Find the order in the list of Recent Orders, and click View.
l In the panel on the left, choose My Orders. Then, find the order in the list and click View.
3. If the refund was applied to store credit, choose Store Credit in the panel on the left.
The amount refunded to your store credit appears in the list with the date and time of the
action.
RMAs can be issued for simple, grouped, configurable, and bundle product types. However,
RMAs are not available for virtual products, downloadable products, and gift cards.
Returns
RMA Workflow
Receive Request. Both registered customers and guests can request an RMA. You can
also submit an RMA request from the Admin.
RMA Issued. After considering the request, you can authorize it partially, completely, or
cancel the request. If you authorize the return and agree to pay for the return shipment,
you can create a shipment order from the Admin with a supported carrier.
Merchandise Returned. The customer follows your shipping instructions and returns
the merchandise to you,
Receive Merchandise. You receive and approve the return partially or completely, or
cancel the RMA.
Configuring Returns
By default, RMA requests can be submitted by customers from the storefront. Requests to
return individual items are managed by the Enable RMA attribute, which is managed in the
Advanced Settings section of each product record, under Autosettings. By default, the
configuration settings are applied to the product. If Enable RMA is set to “No,” the product
does not appear in the list of items that are available for return. An RMA can be generated only
if there is an item in the order that is available for return. Changes to the value of the Enable
RMA attribute apply to both new and existing orders.
To enable RMAs:
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
RMA Settings
Yes Choose “Yes” to have returned products sent to the store address.
No Choose “No,” and enter an alternate address where returned products are to be
sent.
Returns Attribute
The Returns Attributes are used to store information that is needed during the product return
process. The default attributes include the condition of the returned product, the reason for the
return, and a field that indicates how the return was resolved. The process to create a returns
attribute is similar to creating a customer attribute.
Returns Attributes
Billing Agreements
To view transactions:
On the Admin sidebar, tap Sales. Then under Operations, choose Transactions.
Transactions
The Archive option appears in the Sales menu only when archiving is enabled.
To enable archiving:
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
3. Expand the Orders, Invoices, Shipments, Credit Memos Archiving section, and do
the following:
b. In the Archive Orders Purchased field, enter the number of days to wait before completed
orders are archived.
c. In the list, select each Order Status to be Archived. (Hold down the Ctrl key, and click
the status of each item to be archived.)
1. On the Admin sidebar, tap Sales. Then under Operations, choose Orders.
2. Find the order in the grid. Then, mark the checkbox in the first column.
Then, look for the message that order has been archived.
Mark Checkbox
l On the Admin sidebar, tap Sales. Then under Archive, choose Orders.
Like the Orders page, the title of the archived orders page is “Orders.” The only noticeable
difference is the option in the button bar to “Return to Order Management.” The URL of the page
also indicates that you are in the order archive.
1. On the Admin sidebar, tap Sales. Then under Operations, choose Orders.
Look for the message that the archived order has been removed from the archive.
1801
Contents
In this section of the guide, you will learn about the Recommended Solutions
payment methods, services, and gateways that
you can make available to your customers, and PayPal Express Checkout
how to configure them. PayPal In-Context Checkout
PayPal Billing Agreements
PayPal Settlement Reports
Braintree
PayPal Reference
Fraud Protection
Signifyd
1802
CHAPTER 90:
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.
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.
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.
PayPal has deprecated support for the sale of digital goods through PayPal Express Checkout, and
recommends that you use either PayPal Payments Standard or any other PayPal payment gateway
to process any order that includes virtual products.
Requirements
Merchant: Personal PayPal Account
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.
Process Overview:
Step 1: Configure Your PayPal Account
Step 2: Complete the Required Settings
Step 3: Advertise PayPal Credit
Step 4: Complete the Basic Settings
Step 5: Complete the Advanced Settings
1. Before you begin, you must configure your PayPal merchant account on the PayPal website.
b. Go to Service Settings > Hosted Checkout Pages > Set Up, and make the following
settings:
AVS No
CSC No
2. PayPal recommends that you set up an additional user on your account. To set up an
additional user, 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.
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.”
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.”
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.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
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. Then,
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.
l API Signature
l API Certificate
c. If necessary, tap Get Credentials from PayPal. 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.
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
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.
a. Tap Get Publisher ID from PayPal, and follow the instructions to get your account
information.
l Header (center)
l Sidebar (right)
l 190 x 100
l 234 x 60
l 300 x 50
l 468 x 60
l 728 x 90
l 800 x 66
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.
Authorization Approves the purchase, but puts a hold on the funds. The amount is not
withdrawn until it is “captured” by the merchant.
Order The amount of the order is neither captured nor authorized in the
customer’s balance, bank account, or credit card at PayPal. The Order
payment action represents an agreement between the PayPal payment
system and the merchant, which enables the merchant to capture one or
more amounts up to the “ordered” total from the customer’s buyer
account, over a period of up to 29 days. After the funds are “ordered,”
the merchant can capture them at any time during the following 29 day
period. Capturing of the order amount can be done only from the
Magento Admin by creating one or more invoices.
5. To display the “Check out with PayPal” button on the product page, set Display on Product
Details Page to “Yes.”
Authorization Determines how long the primary authorization remains valid. The
Honor Period value should be equal to the corresponding value in your PayPal
(days) 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 Determines how long the order remains valid. When the order becomes
(days) invalid, you can no longer create invoices for it. Specify the value equal
to the Order Valid Period value in your PayPal merchant account. The
default value in your PayPal merchant account is 29. To change this
number, you must contact PayPal.
Number of Child Specifies the maximum number of authorizations for a single order,
Authorizations 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
All Allowed Accepts payment from the countries already specified in your
Countries 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.
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:
g. To allow customers without PayPal accounts to make a purchases with this method, set
Enable PayPal Guest Checkout to “Yes.”
No Does not require the customer’s billing address for any purchases.
For Virtual Quotes Requires the customer’s billing address for virtual quotes only.
Only
i. To specify whether the customer can sign a billing agreement with your store in the PayPal
payment system when there are no active billing agreements available in the customer
account, set Billing Agreement Signup to one of the following:
Auto The customer can either sign a billing agreement during the
Express Checkout flow or use another method of payment.
Ask Customer The customer can decide whether to sign a billing agreement during
the Express Checkout flow.
Never The customer cannot sign a billing agreement during the Express
Checkout flow.
Merchants must ask PayPal Merchant Technical Support to enable billing agreements in their
accounts. The Billing Agreement Signup parameter is enabled only after PayPal confirms that
billing agreements are enabled for your merchant account.
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.”
Advanced Settings
A billing agreement is a sales agreement between the merchant and customer that has been
authorized by PayPal for use with multiple orders. During the checkout process, the Billing
Agreement payment option appears only for customers who have already entered into a billing
agreement with your company. After PayPal authorizes the agreement, the payment system
issues a unique reference ID to identify each order that is associated with the agreement.
Similar to a purchase order, there is no limit to the number of billing agreements a customer
can set up with your company.
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.
Authorization Approves the purchase, but puts a hold on the funds. The
amount is not withdrawn until it is “captured” by the
merchant.
All Allowed Accepts payment from the countries already specified in your
Countries 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.
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.”
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
b. Set Schedule to one of the following options. PayPal retains each report for forty-five
days.
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
c. Set Time of Day to the hour, minute, and second when you want the reports to be
generated.
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.
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
a. Enter the name of the Page Style that you want to apply to your PayPal merchant
pages. Options include:
primary Uses the page style that you identified as the “primary” style 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:
Page Background Background color for the checkout page and around the header
Color and payment form.
4. PayPal's Express Checkout Smart Payment Buttons feature allows you to customize the
PayPal button, which can be displayed on the Checkout, Product Detail, Cart, and Mini
Cart pages, PayPal's internal research suggests that the default options are highly
recognizable and might lead to increase purchase rates, but their defaults might not
match your store's styling. You can choose:
Responsive Default sizing. Adjusts to the width of the container. The minimum
width is 100 pixels, and the maximum width is 500 pixels. The
height dynamically adjusts based on the width.
Pill Default shape. The button is shaped like a pill, or long in the center
and curved on the ends.
l Gold (Default)
l Blue
l Silver
l Black
Disable Funding Options determines which other PayPal funding options are displayed on
the Checkout page. Selected options will never be displayed on the Checkout page. Unselected
options will be displayed only if PayPal supports the store's currency and the buyer's location.
Options:
l PayPal Credit
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.”
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
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.
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.
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.
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:
Field Descriptions
FIELD DESCRIPTION
PayPal Reference ID Type One of the following reference codes:
Order ID
Transaction ID
Subscription ID
Braintree
Braintree offers a fully customizable checkout experience with fraud detection and PayPal
integration. Braintree reduces the PCI compliance burden for merchants because the
transaction takes place on the Braintree system.
Configure Braintree
Setting Up Braintree
Process Overview:
Step 1: Get Your Braintree Credentials
Step 2: Complete the Basic Settings
Step 3: Complete the Advanced Settings
Step 4: Complete the Country-Specific Settings
Step 5: Complete the PayPal through Braintree Settings
Step 6: Complete the 3D Verification Settings
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
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:
Configure Braintree
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.”
Authorize Only Approves the purchase and puts a hold on the funds. The amount
is not withdrawn from the customer’s bank account until the sale is
“captured” by the merchant.
l Public Key
l Private Key
Basic Settings
5. To include PayPal as a payment option with Braintree, set Enable PayPal through Braintree
to “Yes.”
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
2. In the Vault Title field, enter a descriptive title for your reference that identifies the vault where
your customer card information is stored.
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.
Advanced Settings
l Specific Countries
For Payment from Specific Countries, hold down the Ctrl key and select each country from
which you accept payment.
Country-Specific Settings
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.
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 merchant name differently than what is defined in your store
configuration, enter the name as you want it to appear in the Override Merchant Name
field.
Authorize Approves the purchase and puts a hold on the funds. The amount is not
withdrawn from the customer’s bank account until the sale is “captured”
by the merchant.
Authorize and The amount of the purchase is authorized and immediately withdrawn
Capture from the customer’s account.
3. Set Payment from Applicable Countries to one of the following for Braintree transactions
processed by PayPal:
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.”
8. To display the PayPal button on both the mini shopping cart and shopping cart page, set
Display on Shopping Cart to “Yes.”
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 minimum order amount that is required to trigger 3D
verification.
l Specific Countries
To Verify for Specific Countries, hold down the Ctrl key and select each country from which
payments are to be verified.
3D Verification Settings
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
Phone The Phone descriptor must be ten to fourteen characters in length, and
can include only numbers, dashes, parentheses, and periods. For
example:
9999999999
(999) 999-9999
999.999.9999
URL The URL descriptor represents your domain name, and can be up to
thirteen characters long. For example: company.com
The selection of available PayPal solutions varies by merchant location. PayPal Express
Checkout and PayPal Payments Standard can be used in all parts of the world. To learn more,
see: PayPal Solutions by Country.
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.
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.
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.
Customer Places Order. In the final stage of checkout, the customer taps the Place
Order button.
Magento Sets Order Status. Magento receives response from PayPal, and sets the
order status to one of the following:
Pending Payment The system did not receive any response from PayPal.
Suspected Fraud The transaction did not pass some of the PayPal fraud filters.
The system receives the response from PayPal that the
transaction is under review by Fraud Service.
Merchant Fulfills Order. The merchant invoices and ships the order.
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.
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.
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:
Capture PayPal transfers the order amount from the buyer’s balance,
bank account or credit card to the merchant’s account.
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.
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.
For step-by-step configuration instructions, see PayPal Payments Standard in the online user
guide.
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.
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.
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.
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.
Pending Payment The system did not receive any response from PayPal.
Suspected Fraud The transaction did not pass some of the PayPal fraud filters.
The system receives the response from PayPal that the
transaction is under review by Fraud Service.
Cancel Payment. If the customer clicks the Cancel Payment link, the customer returns
to the Payment Information stage of checkout, and the order status changes to
“Canceled.”
Merchant Fulfills Order. The merchant invoices, and ships the order as usual.
PayPal Reference
PAYPAL SOLUTION DESCRIPTION
EXPRESS CHECKOUT
ALL-IN-ONE SOLUTIONS
PayPal Payments Advanced (Includes Express Allows you to accept payments with a
Checkout) PCI-compliant checkout that keeps
customers on your site.
PayPal Payments Pro (Includes Express Checkout) Allows you to accept payments with a
PayPal Website Payments Pro (Outside US) completely customizable checkout.
PAYMENT GATEWAYS
PayPal Payflow Pro (Includes Express Checkout) Connects your merchant account with a
fully customizable gateway that lets
customers pay without leaving your site.
PayPal Payflow Link (Includes Express Checkout) Connects your merchant account with a
PCI-compliant gateway that lets
customers pay without leaving your site.
Customers who use PayPal Express Checkout or Express Checkout for Payflow Pro must have a
PayPal buyer account. PayPal Payments Standard (which is some countries is called Website
Payments Standard) can be used directly or through a buyer account, provided that the
merchant enables PayPal Account Optional. By default, this parameter is enabled. Customers
can choose to enter their credit card information, or create a buyer account with PayPal. When
disabled, customers must first create a PayPal buyer account before making a purchase.
Website Payments Pro, Website Payments Pro Payflow Edition, Payflow Pro Gateway, and
Payflow Link require customers to enter credit card information during checkout.
PayPal Credit
PayPal Credit offers your customers quick access to financing, so they can buy now and pay
over time, at no additional cost to you. You are not charged when customers choose PayPal
Credit, and pay only your normal PayPal transaction fee.
According to a recent study, nearly 40% of PayPal Credit users say they spent more online
because financing was available. Plus, their transactions are up to 68% larger than credit/debit
purchases. 1 To learn more, see PayPal Credit on the PayPal website.
Give your sales a boost when you advertise financing. PayPal helps turn browsers into buyers
with financing with PayPal Credit. Your customers can pay over time, while you get paid up
front – at no additional cost to you. Use PayPal’s free banner ads that let you advertise PayPal
Credit financing as a payment option when your customers check out with PayPal. The PayPal
Advertising Program has been shown to generate additional purchases as well as increase
consumer's average purchase sizes by 15% or more.
You can easily add free, ready-made banner ads to pages of your stie, and the PayPal Credit
button to your shopping cart during checkout to remind your customers that financing is
readily available.
For US merchants, PayPal Credit is included as a PayPal Express Checkout option, and is
available with PayPal All-In-One Solutions (Payment Advanced, Payments Pro, and Payments
Standard) and PayPal Payment Gateways (PayFlow Pro and PayFlow Link). Before you
configure PayPal Credit for your Magento store, make sure it is enabled in your PayPal account.
Give your customers access to financing with PayPal Credit, at no additional cost to you. You
get paid up front, even though customers can pay over time. A pre-integrated payment button
lets customers pay quickly with PayPal Credit.
1. On the Admin sidebar, choose Stores. Then under Settings, choose Configuration.
4. Complete the Required PayPal Settings. Then, expand Advertise PayPal Credit.
1. On the Admin sidebar, choose Stores. Then under Settings, choose Configuration.
4. Expand the Required PayPal Settings section. Then, expand the Advertise PayPal
Credit section.
5. Click the Get Publisher ID from PayPal button and follow the directions to get your account
information. Then, enter your Publisher ID.
l Header (center)
l Sidebar (right)
l 190 x 100
l 234 x 60
l 300 x 50
l 468 x 60
l 728 x 90
l 800 x 66
Banner Sizes
These examples do not represent the actual size of the banners, but show their relative shape
and proportion.
1 As reported in Neilsen’s PayPal Credit Average Order Value Study for activity occurring from
April 2015 to March 2016 (small merchants) and October 2015 to March 2016 (midsize
merchants), which compared PayPal Credit transactions to credit and debit card transactions
on websites that offer PayPal Credit as a payment option or within the PayPal Wallet. Nielsen
measured 284890 transactions across 27 mid and small merchants. Copyright Nielsen 2016.
Filter Actions
ACTION DESCRIPTION
Review If you set the filter action to “Review,” the suspected order receives the
status ”Payment Review” when the order is placed. You can review the order
and approve, or cancel the payment in the Admin, or on the PayPal side.
When you click the Accept Payment or the Deny Payment buttons, no new
transactions for the order are created.
If you change the status of the transaction on the PayPal site, you must click
the Get Payment Update button in the upper-right corner of the Order page in
the Admin to apply the changes. If you click Accept Payment or Deny
Payment, the changes made at the PayPal site are applied.
Deny If you set the filter action to “Deny,” the suspected order cannot be placed by
the customer, because the corresponding transaction is rejected by PayPal.
To deny the payment from the Admin, click the Deny Payment button in the
upper-right corner of the page. The order status changes to “Canceled,” the
transaction is reverted, and funds are released on the customer’s account.
The corresponding information is added in the Comments History section of
the order view.
Flag 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.
PayPal by Country
PayPal Payment Solutions
COUNTRY PAYPAL PAYMENT SOLUTION
Australia PayPal Website Payments Standard
PayPal Payflow Pro
PayPal Website Payments Pro Hosted Solution
PayPal Express Checkout
Hong Kong SAR China PayPal Website Payments Pro Hosted Solution
PayPal Website Payments Standard
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
l Klarna
l Amazon Pay
l Authorize.Net
l Cybersource
l eWAY
l Worldpay
Klarna
Klarna lets your customers choose how they want to pay, and supports the purchase with
buyer protection and excellent customer service.
New Features
l The Klarna Payments section of the Magento configuration now links to Klarna for
automated onboarding or to log in to your account.
l Klarna denies and attempts to cancel any order that is identified as fraudulent.
Pay Now
Customers can pay in full quickly and securely with
Direct Bank Transfer/Direct Debit.
Pay Later
Customers can buy now, and pay later. You get paid
immediately, and Klarna takes care of the rest.
Slice It
Customers can spread the cost of their purchases over
time at a low interest rate. Klarna’s credit application
process takes less than thirty seconds to complete.
3. After the terms of the credit are approved, tap Place Order.
Pay later
The terms appear below. In this example, no sign-up is needed, and the customer can pay in
14 days.
Pay Later
2. To pay later with Klarna according to the terms specified, tap Place Order.
Setting Up Klarna
To offer your customers the benefit of paying with Klarna, you must first sign up for a Klarna
account and gain access to the Klarna Merchant Portal. Then, complete the Klarna
configuration from the Admin of your Magento store.
Important: Klarna does not support currency switches to display multiple currencies in one website.
Magento uses a base currency and tax configured at the website level (not store view) to avoid
rounding and mismatch issues. To support multiple currencies, create a website per currency, using
different URLs configured at the Magento website level (not store view).
a. In the Admin sidebar, choose Stores. Then under Settings, choose Configuration.
c. In the Klarna section, tap Configure. Then under Klarna Payments, click the link to visit
the Klarna Merchant Onboarding page.
l To create a new account, complete the Onboarding form to create a Klarna merchant
account. Then, tap Create account.
3. To generate your API Credentials for Klarna’s Playground environment, do one of the following:
b. Copy your credentials to a text editor like Notepad. You will need them later to complete
the Magento configuration.
4. If necessary, sign in to your Klarna account. Then on the Store Settings tab, do the following:
a. Take note of your Store ID in the upper-left corner of the page. Copy and paste the value
into a text editor like Notepad, along with your API credentials.
l Store name
l Homepage URL
Store Settings
c. In the upper-right corner, click the Menu icon ( ). Then, choose Branding.
If your logo and icon files are ready, follow the onscreen instructions to upload them to the
Klarna portal. If the files aren’t ready, you can complete this step later.
Branding
1. Open another browser tab, and log in to the Admin of your Magento store.
3. In the upper-left corner, choose the Store View where the configuration applies. If your
installation has only one view, accept the “Default Config” setting.
4. In the panel on the left, under Sales, choose Payment Methods. Under Other Payment
Methods, expand the Klarna section. Then, tap Configure.
Klarna
b. In the Merchant ID/EID field, enter the Store ID from your Klarna account.
d. To use the Klarna Playground for test transactions, set Test Mode to “Yes.”
e. To generate a record of interactions while testing the integration, set Debug Mode to
“Yes.”
Turn Debug Mode off before going live with Klarna in your production store.
Klarna API
All Allowed Customers from all countries specified in your store configuration
Countries 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.
c. (U.S. Only) If you want Klarna to prepare set of personalized credit options for each
customer, set Data sharing to “Yes.”
d. Enter a Sort Order number to determine the position of Klarna in the list of payment
methods during checkout. (0 = first, 1 = second, 2 = third, and so on.)
Klarna Payments
8. When prompted, click the Cache Management link at the top of the page. Then, refresh all
invalid caches.
Enter the hexadecimal value of the color that you want to use for each element.
l Details color
l Button color
l Checkbox color
l Header color
l Link color
l Border color
l Text color
l Border radius
9. When complete, tap Save Config. Then when prompted, click the Cache Management link at
the top of the page to refresh all invalid caches.
Orders are captured with shipping details from the Magento Admin. Klarna also supports post
order processing for events such as cancellations, refunds, and fraud.
To manage orders:
1. Do one of the following:
Find an Order
l Unacknowledged
l Uncaptured
l Captured
l Cancelled
Show
2. To find a specific order, enter any of the following into the Search for order box:
l Merchant reference
l Klarna reference
l Order ID
3. To view the order detail, click the linked Klarna reference number in the first column.
The amount of detail that is included in the report depends on your configuration. For
example, if Fixed Product Taxes are enabled and applicable to the order, the amount
appears in the product line item.
Order Detail
Export Orders
2. Look for the export file in your browser’s downloads list. Then, open the file in a
spreadsheet application.
Amazon Pay
Amazon Pay and Login with Amazon offer your customers a secure and convenient way to pay
that is easy to set up, and that helps to increase conversions and sales. Customers who log in
to your store with their Amazon credentials can speed through checkout using the payment
and shipping information that is already stored in their Amazon accounts.
For international merchants with a region in EU or UK, Amazon Pay provides a multi-currency
feature. If you list prices in more than one currency, this feature allows a customer to select
their currency and pay the exact amount quoted on the site, without concern for conversion or
rates.
New Features
l Amazon Pay now support Klarna Payments.
Shop Safely
Customer purchases are protected by Amazon’s A-to-z
Guarantee. Customer password and payment
information is never shared.
For international customers, they may also have an option to select their preferred currency if
you list prices in more than one currency. This multi-currency support allows customers to
complete purchases without worrying about currency conversions or rates.
Shipping Addresses
The pagination indicator shows how many addresses are available. However, only four can be
viewed at a time.
3. Choose the Shipping Method that you want to use for the order. Then, tap Next.
4. During the Review & Payments checkout step, the standard Magento payment methods are
replaced with the payment methods that are available in your Amazon account.
l Choose the Payment Method that you want to use for the purchase.
a. In the upper-right corner, set the Store View chooser to establish where the Amazon Pay
configuration applies.
b. In the panel on the left under Sales, choose Payment Methods. Then under Other
Payment Methods, expand the Amazon Pay section.
Amazon Pay
a. If you do not yet have an Amazon merchant account, choose Create a new signin, and tap
Select. Then, follow the onscreen instructions to create a new account.
b. If you already have an Amazon merchant account, choose Use existing Amazon signin,
and tap Select. Then, complete the following sections:
Credentials
1. Expand the Credentials section. Your credentials are transferred automatically from
your Amazon Pay account to the Magento Admin. Your credentials can also be found in
Amazon Seller Central in both Production and Sandbox modes.
To use test credentials from the Amazon Pay Sandbox, do the following:
b. In the Magento Amazon Pay configuration under Credentials, mark the Test
Credentials checkbox.
c. Enter the following credentials that you copied from the Amazon Pay Sandbox on
Amazon Seller Central:
l Merchant Id
l Access Key Id
l Client ID
l Client Secret
When you are through testing and ready to go live with Amazon Pay, return to the
configuration and clear the Test Credentials checkbox. Then, set Sandbox to “No”
and tap Save Config.
Credentials
3. When complete, tap Save Config.
Look for the message, “Your Amazon configuration is valid” at the top of the Configuration
page.
Options
Charge on Order Amazon creates the invoice and charges the customer when the
order is placed.
5. Set Authorization Mode to one of the following to determine the method that is used to
transmit authorization data.
Data Polling via (Default) Uses the standard Magento notification process that is
Cron job scheduled by Cron job.
Instant Payment (IPN) Sends notifications to the Instant Payment Notification URL.
Notifications
Options
Advanced Settings
a. (Optional) If your store is available in multiple languages, you can display the text
on the Amazon Pay button in a different language for each store view. To override the
default display language for the current store view, enter one of the following
language parameters in the Button Display Language field:
l Gold
l Light Gray
l Dark Gray
To learn more, see the Merchant Tools page on the Amazon Pay website.
l Small
l Medium
l Large
l Extra Large
d. Choose “Yes” for each feature that you want to enable for the current store view:
Frontend
2. Expand the Sales Options section. Then, enter the Store Name.
Sales Options
3. If you have a payment region in EU or UK, you may have an option for Use Multi-currency.
Amazon Pay multi-currency feature is supported for the payment regions EU and UK.
l Euro (EUR)
Sales Options
5. In the message at the top of the page to refresh cache types, click Cache Management. Then,
do the following:
To change views:
Set the chooser to the view that you want to see. The following views relate to the Magento
integration of Amazon Pay:
3. On the main menu, under Integration, choose MWS Access Keys. Then, do the following:
b. Your keys are formatted as a JSON string, with each item enclosed in double quotes. Copy
your keys, and paste them into Notepad. Then, Close the box. You will need them to
complete the Amazon Pay configuration for Sandbox Mode in the Magento Admin.
Your Credentials
To issue a refund:
1. On the Admin sidebar, choose Sales. Then on the menu, choose Orders.
2. Find the completed order to be refunded. Then in the Action column, click View.
4. Scroll down to the bottom of the page, and confirm the Refund Totals.
1. Go to pay.amazon.com.
2. In the header at the Sign In prompt, choose Merchants. Then, do the following:
Merchant Sign In
4. To view orders from a specific region, choose the region from the Account Activity control.
5. To find an order, click Can’t find an order? Then, choose the Amazon service that processed
the order.
To find help:
1. Log in to your Amazon seller account on Seller Central.
3. In the header, set the integration chooser to “Amazon Pay (Sandbox View).”
l The Getting Started Guide in the center of the page offers step-by-step instructions for
implementing Amazon Pay.
l You’ll find additional guides for developers In the right sidebar under Documentation, and
additional resources under Help and FAQ.
Deprecation Notice: Authorize.Net has deprecated the Authorize.net Direct Post (Deprecated)
payment method. If you use this method, you must update the MD5 Hash key with a new
Signature key . The Authorize.Net payment method must be set up as the replacement payment
method. Refer to Authorize.Net for more information.
Customer Workflow
Customer chooses payment method. During checkout, the customer chooses
Authorize.net Direct Post (Deprecated) as the payment method.
Customer submits the order. The customer enters the credit card information, reviews
the order, and taps the Place Order button.
l If the transaction fails, an error message appears, and the customer can try a different
card, or choose a different payment method.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
3. Expand the Authorize.Net Direct Post (Deprecated) section. Then, do the following:
Authorize and Capture Funds on the customer's card are authorized and captured
by Authorize.Net, and an order and invoice are created in
your store’s Admin.
c. Enter a Title to identify the Authorize.Net Direct Post (Deprecated) payment method
during checkout.
l API Login ID
l Transaction Key
2. In the Merchant MD5 field, enter the hash value from your Authorize.Net merchant Account.
The value is located on the Authorize.Net website at Account > Settings > Security Settings >
MD5-Hash.
l Suspected Fraud
l Processing
4. To operate temporarily in a test environment, set Test Mode to “Yes.” When you are ready to
process live transactions, set Test Mode to “No.”
When testing the configuration in a sandbox, use only the credit card numbers that are
recommended by Authorize.Net.
5. Enter the Gateway URL that establishes the connect to the Authorize.Net server. The default
value is:
https://secure.authorize.net/gateway/transact.dll
If you have received a temporary URL for test transactions, don’t forget to restore the original
URL when you are ready to process live transactions.
2. To save messages transmitted between your store and the Authorize.Net Direct Post system, set
Debug to “Yes.”
a. If you want Authorize.Net to send an order confirmation notification to the customer, set
Email Customer to “Yes.”
b. In the Merchant’s Email field, enter the email address where you want to receive
notification of orders placed with Direct Post. Leave blank if you do not want to receive
notification.
a. In the Credit Card Types list, select each credit card that is accepted in your store.
b. To require customers to enter a card verification value (CVV), set Credit Card Verification
to “Yes.”
All Allowed Customers from all countries specified in your store configuration
Countries 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.
d. Enter the Minimum Order Total and Maximum Order Total for Direct Post transactions.
To qualify, the order total must exactly match the minimum or maximum threshold, or
fall somewhere in between.
e. Enter a Sort Order number to determine the position of Direct Post in the list of payment
methods during checkout. (0 = first, 1 = second, 2 = third, and so on.)
Authorize.net
The Authorize.net payment method has replaced the Authorize.Net Direct Post (Deprecated)
payment method. 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 can be used with orders created from the Admin as well as
from the store.
Authorize.Net has deprecated the Authorize.Net Direct Post (Deprecated) payment method. To
ensure payments continue to process correctly, configure Authorize.Net payment method for
transactions.
Customer Workflow
Customer chooses payment method. During checkout, the customer chooses
Authorize.Net as the payment method.
Customer submits the order. The customer enters the credit card information, reviews
the order, and taps the Place Order button.
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
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
4. Enter a unique Title to identify the Authorize.Net payment method during checkout.
5. In the Environment field, select Sandbox or Production. This setting is based on your
Authorize.Net merchant account type.
Authorize and Capture Funds on the customer's card are authorized and captured
by Authorize.Net, and an order and invoice are created in
your store’s Admin.
7. In the API Login ID field, enter the login ID from your Authorize.Net merchant account.
Obtain the value in your Authorize.Net account at Account > Settings > Security Settings >
API Credentials & Keys.
8. In the Transaction Key field, enter the key value from your Authorize.Net merchant account.
Obtain the value in your Authorize.Net account at Account > Settings > Security Settings >
API Credentials & Keys.
If you have previously generated a transaction key, you will enter the value. If you don't know your
existing transaction key or have never established one, you can generate a new key in your
Authorize.Net merchant account. If generating a new key to replace an existing key, it is important
to update any existing applications that use the transaction key.
9. In the Public Client Key field, enter the key value from your Authorize.Net merchant account.
Obtain the value in your Authorize.Net account at Account > Settings > Security Settings >
Manage Public Client Key.
10. In the Signature Key field, enter the key value from your Authorize.Net merchant account.
Obtain the value in your Authorize.Net account at Account > Settings > Security Settings >
API Credentials & Keys.
11. Skip the Merchant MD5 (deprecated) field. Authorize.Net does not use this data field.
1. When all of the Basic Authorize.Net Settings are completed, set the Enabled field to “Yes.”
1. To set the default status for all new orders, set New Order Status to one of the following:
l Processing
l Suspected Fraud
3. To save messages transmitted between your store and Authorize.Net, set Debug to “Yes.”
4. If you want Authorize.Net to send an order confirmation notification to the customer, set
Email Customer to “Yes.”
Merchant email settings can be configured in your Aurthorize.Net merchant account at Account
> User Profile > Edit Profile Information.
5. To require customers to enter a card verification value (CVV), set Enable Credit Card
Verification Field to "Yes." Default is "Yes."
6. In the Credit Card Types list, select each credit card that is accepted in your store.
All Allowed Customers from all countries specified in your store configuration
Countries 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.
8. Enter the Minimum Order Total and Maximum Order Total for store transactions. To qualify,
the order total must exactly match the minimum or maximum threshold, or fall somewhere in
between.
9. Enter a Sort Order number to determine the position that Authorize.Net will display in the list
of payment methods during checkout. (0 = first, 1 = second, 2 = third, and so on.)
10. To save your configuration settings, tap Save Config before exiting.
CyberSource
CyberSource was one of the pioneers in the early online payment industry, and later acquired
Authorize.Net. Today, CyberSource is a wholly-owned subsidiary of Visa Inc. Over 400,000
businesses worldwide use CyberSource to process online payments, streamline fraud
management, and to simplify payment security. The company is based in Foster City,
California, and has offices throughout Asia, Europe, Latin America, the Middle East, Africa,
and the United States.
CyberSource supports shipments to multiple addresses as part of the checkout flow. The order
is duplicated for each address that the customer wants to ship to.
2. Accept the Default Payment action of “Authorized Only,” which approves the purchase and
puts a hold on the funds. The amount is not withdrawn from the customer’s bank account
until the sale is “captured” by the merchant.
Enable CyberSource
l Merchant ID
l Profile ID
l Transaction Key
l Access Key
l Secret Key
1. Set New Order Status to one of the following order status settings:
l Processing
l Suspected Fraud
2. To run CyberSource in a test environment before going live, set Test Mode to “Yes.”
When you are ready to go live with CyberSource, set Test Mode to “No.”
3. If you want the system to save a log file of interactions between your store and CyberSource, set
Debug to “Yes.”
4. Set Credit Card Types to each card that you accept as payment. To choose multiple credit
cards, hold down the Ctrl key and click each option.
l Specific Countries
For Payment from Specific Countries, hold down the Ctrl key and select each country from
which you accept payment.
2. To set limits on the total amount that is allowed for any order, enter the Minimum Order Total
and Maximum Order Total.
3. In the Sort Order field, enter a number to determine the sequence in which CyberSource
appears when listed with other payment methods during checkout.
Remaining Information
eWAY
eWAY is based in Australia, and provides secure payment processing services to merchants
throughout Australia, New Zealand, the United Kingdom, Singapore, Malaysia, and Hong
Kong. Their latest Rapid 3.1 API enables real-time fraud protection.
1. Log in to the Admin of your store. On the Admin sidebar, tap Stores. Then under Settings,
choose Configure.
Enable eWAY
Responsive shared Redirects to a page for your store that is hosted on the eWAY server
page to complete the transaction.
1. To run test transactions in a test environment, set Sandbox Mode to “Yes.” To learn more, see:
Sandbox/Testing on the eWAY website.
When you are ready to go live with eWAY, set Sandbox Mode to “No.”
2. Follow the instructions on the eWAY website to set up your Live API key and password. Then,
enter the following:
3. Follow the instructions on the eWAY website to set up your sandbox credentials. Then, enter
the following:
l Sandbox API Key
eWAY Credentials
Authorize Only Approves the purchase and puts a hold on the funds. The amount is not
withdrawn from the customer’s bank account until the sale is “captured”
by the merchant.
Authorize and The amount of the purchase is authorized and immediately withdrawn
Capture from the customer’s account.
2. To save a record of communications between your store and the eWAY system in a log file, set
Debug to “Yes.”
In accordance with PCI Data Security Standards, credit card information is not recorded in the log
file.
3. In the Credit Card Types box, hold down the Ctrl key and select each credit card that is
accepted as payment in your store.
Configure Payments
l Specific Countries
For Payment from Specific Countries, hold down the Ctrl key and select each country from
which you accept payment.
Configure Countries
5. In the Sort Order field, enter a number to determine the order in which eWAY appears when
listed with other payment methods during checkout.
Worldpay
London-based Worldpay has twenty-five offices in eleven countries around the world. The
company is a global leader in card payments, multi-currency processing, and provides local in-
store and mobile payment acceptance solutions for companies large and small.
Enable Worldpay
l Installation ID
Worldpay Credentials
1. If you want customers to be able to edit their contact information, set Allow to Edit Contact
Information to “Yes.”
2. If you don’t want to show customers their contact information, set Hide Contact Information
to “Yes.”
Contact Information
1. If you want the system to save a log file of interactions between your store and Worldpay, set
Debug to “Yes.”
2. To run Worldpay in a test environment before going live, set Test Mode to “Yes.”
When you are ready to go live with Worldpay, set Test Mode to “No.”
Test Mode
1. To determine the payment action used for test transactions, set Payment Action for Test to
one of the following:
l Authorised
l Error
l Captured
2. To determine the payment action used for live transactions, set Payment Action to one of the
following:
Authorize Only Approves the purchase and puts a hold on the funds. The amount is not
withdrawn from the customer’s bank account until the sale is “captured”
by the merchant.
Authorize and The amount of the purchase is authorized and immediately withdrawn
Capture from the customer’s account.
l Specific Countries
For Payment from Specific Countries, hold down the Ctrl key and select each country from
which you accept payment.
Configure Payments
Set both Order Status to Suspected Fraud for CVV and Order Status to Suspected Fraud tor
Postcode AVS to one of the following:
l None
l Not Supported
l Not Checked
l Not Matched
l Partially Matched
Fraud Settings
1. In the Sort Order field, enter a number to determine the sequence in which Worldpay appears
when listed with other payment methods during checkout.
Sort Order
Offline Payments
Online Payments
b. Enter a Title to identify the Check / Money Order payment method during checkout.
All Allowed Customers from all countries specified in your store configuration
Countries 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.)
Cash On Delivery
Magento Commerce allows you to accept COD payments for purchases. You can accept COD
payment from only specific countries, and fine-tune the configuration with minimum and
maximum order total limits.
The shipping carrier receives payment from the customer at the time of delivery, which is then
transferred to you. You can make an adjustment for any fee charged by the carrier service in
your shipping and handling charges.
All Allowed Customers from all countries specified in your store configuration
Countries 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. 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.)
Bank Transfer
Magento Commerce allows you to accept payment that is transferred from a customer’s bank
account and deposited into your merchant bank account.
b. Enter a Title to identify the Bank Transfer Payment method during checkout.
All Allowed Customers from all countries specified in your store configuration
Countries 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 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.)
Purchase Order
A purchase order (PO) allows commercial customers to pay for authorized purchases by
referencing the PO number. The purchase order is authorized and issued in advance by the
company that is making the purchase. During checkout, the customer chooses Purchase Order
as the method of payment. Upon receipt of your invoice, the company processes the payment
in their accounts payable system, and pays for the purchase.
Before accepting payment by purchase order, always establish the credit worthiness of the
commercial customer.
Purchase Order
All Allowed Customers from all countries specified in your store configuration
Countries 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.)
l A discount covers the entire price of the purchase, with no additional charge for shipping.
l The customer adds a downloadable or virtual product to the shopping cart, and the price
equals zero.
l The price of a simple product is zero, and the Free Shipping method is available.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
3. Click to expand the Zero Subtotal Checkout section. Then, do the following:
c. If orders typically wait for authorization, set New Order Status to “Pending” until payment
is authorized.
d. Set Automatically Invoice All Items to “Yes” if you want to automatically invoice all items
that have a zero balance.
All Allowed Customers from all countries specified in your store configuration
Countries 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.)
Signifyd’s Guaranteed Fraud Protection protects every approved order with a financial
guarantee against fraudulent chargebacks, so you can grow your business without fear of fraud.
1. Complete Signifyd’s Guaranteed Fraud Protection form to contact their Sales team.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
Signifyd Configuration
b. From the Settings page of your Signifyd console, enter the API Key .
d. If you want Magento to keep a log of all interactions between your store and Signifyd, set
Debug to “Yes”.
e. The Webhook URL is the location of the handler that synchronizes Signifyd’s guarantee
decisions with your store, and cannot be changed from the Admin.
1928
Contents
Studies show that stores offering customers a Shipping Settings
choice of several shipping methods have higher
conversion rates than those that use a single Shipping Policy
method for all shipments. In this section of the Basic Shipping Methods
guide, you will learn how to set up a variety of
Free Shipping
shipping methods and carriers, and print shipping
Flat Rate
labels.
Table Rate
Dimensional Weight
Carriers
Shipping Labels
Shipping Label Workflow
Configuring Shipping Labels
Creating Shipping Labels
1929
CHAPTER 94:
Shipping Settings
The shipping configuration establishes the point of origin for all shipments, your shipping
policy, and the handling of shipments to multiple addresses.
l Point of Origin
l Shipping Policy
Shipping Settings
Point of Origin
The point of origin is used to calculate the charge for shipments made from your store or
warehouse, and also determines the tax rate for products sold. When calculating EU taxes,
make sure that the Default Tax Destination Calculation for each store view corresponds to the
Shipping Settings point of origin.
Origin
l Country
l Region / State
l City
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.
Shipping Policy
A shipping policy should explain your company's business rules and guidelines for shipments.
For example, if you have price rules that trigger free shipping, you can explain the terms in
your shipping policy.
To display your shipping policy during checkout, complete the Shipping Policy Parameters in
the configuration. The text appears when customers click the “See our shipping policy” link
during checkout.
b. Either paste or enter your Shipping Policy into the text box.
If you use a word processor to compose the text, make sure to save the document as a .txt file
to remove any control characters from the text. Then, copy and paste the text into the Shipping
Policy text box.
l Free Shipping
l Flat Rate
l Table Rates
l Dimensional Weight
Free Shipping
Free shipping is one of the most effective promotions you can offer. It can be based on a
minimum purchase, or set up as a cart price rule that is applied when a set of conditions is
met. If both apply to the same order, the configuration setting takes precedence over the cart
rule.
Check your shipping carrier configuration for any additional settings that may be required for free
shipping.
Free Shipping
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
To use Free Shipping with Table Rates, make the Minimum Order Amount so high that it is
never met. This prevents Free Shipping from going into effect, unless it is triggered by a price
rule.
e. In the Displayed Error Message box, type the message to appear if free shipping becomes
unavailable.
All Allowed Customers from all countries specified in your store configuration
Countries 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.
Yes Always shows the Free Shipping method, even when not 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.)
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.
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.
Flat Rate
Flat rate is a fixed, predefined charge that can be applied per item, or per shipment. Flat rate is
a simple shipping solution, especially when used with the flat-rate packaging that is available
from some carriers. When enabled, Flat Rate appears as an option during checkout. Because no
specific carrier is specified, you can use a carrier of your choice.
Flat Rate
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.
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 Disables the payment type. The Flat Rate option is listed in the
cart, but with a rate of zero—which is the same as free shipping.
Per Order Charges a single flat rate for the entire order.
Per Item Charges a single flat rate for each item. The rate is multiplied by the
number of items in the cart, regardless of whether there are multiple
quantities of the same, or of different items.
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.
All Allowed Customers from all countries specified in your store configuration
Countries 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.)
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.
Process Overview:
Step 1: Complete the Default Settings
Step 2: Prepare the Table Rate Data
Step 3: Import the Table Rate Data
Step 4: Verify the Rates
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.
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.
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.
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.
All Allowed Customers from any country specified in your store configuration
Countries 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.)
Table Rates
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.
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.
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.
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.
ORDER
REGION / ZIP / POSTAL SUBTOTAL SHIPPING
COUNTRY STATE CODE (and above) PRICE
USA HI * 100 10
USA HI * 50 15
USA HI * 0 20
USA AK * 100 10
USA AK * 50 15
USA AK * 0 20
USA * * 100 5
USA * * 50 10
USA * * 0 15
AUS NT * 0 19.95
AUS WA * 9 39.95
AUS WA * 0 19.95
AUS * * 9 29.95
AUS * * 0 9.95
1. Create a tablerates.csv file that includes all the state destinations to which you are
willing to provide free shipping.
SETTING VALUE
Condition Price v. Destination
3. Set Store View to the main website. Then, tap Import to import the tablesrates.csv file.
Dimensional Weight
Dimensional weight, sometimes called volumetric weight, is a common industry practice that
bases the transportation price on a combination of weight and package volume. In simple
terms, dimensional weight determines the shipping rate based on the amount of space a
package occupies in the cargo area of the carrier. Dimensional weight is typically used when a
package is relatively light compared to its volume.
All major carriers apply dimensional weight to some shipments. However, the manner in which
dimensional weight pricing is applied varies from one carrier to another.
We recommend that you use Magento Shipping to calculate dimensional weight for all
carriers.If your company has a high volume of shipments, even a slight difference in shipping
price can translate to thousands of dollars over the course of a year.
l Automatically checks for conflicts with extensions during setup to help avoid issues during
development and testing.
Release 2.3.1
New Features
l Shipment Cancellation
Improvements
l Shipment Workflow
l Batch Processing
l Collection Points
l Carrier-Specific Packaging
l Qualify Experience
Supported Countries
COUNTRY CARRIER SUPPORT
Australia FedEx pre-negotiated rates, and ad-hoc returns for FedEx, USPS,
Australia Post, UK Mail, and DHL Express.
United Kingdom FedEx pre-negotiated rates, and ad-hoc returns for FedEx, USPS,
Australia Post, UK Mail, and DHL Express.
United States FedEx pre-negotiated rates, and ad-hoc returns for FedEx, USPS,
Australia Post, UK Mail, and DHL Express.
Quick Look
Advanced Shipments
Magento Shipping is now available in seventeen
countries, where you can create shipments with
advanced features such as route and package
information with dimensional weight, carrier quotes,
international details with required export information,
harmonization codes, shipping documents and labels,
delivery instructions, and tracking information.
Locations
Configure multiple warehouses, distribution centers,
retail stores, dropshippers, and third-party logistics.
Allocate shipments to any supported fulfillment location.
Collection Points
Collection points allow customers to order online and
have it shipped to a designated collection point, rather
than to their address.
Dispatches
Book shipments with all carriers, and maintain a manifest
of scheduled pickup with selected carriers.
Batches
Orders that are ready to ship with Magento Shipping can
be booked together as multiple shipments, and
processed as a batch.
Shipping Partners
Receive real-time rates from global carriers, and
configure multiple accounts with the same carrier across
multiple locations. Access prenegotiated rates for
selected carriers, or create your own negotiated rates in
selected markets.
Packaging
Manage package names and dimensions, and access
carrier supplied packaging information.
Customer Experience
From the storefront, Magento Shipping options appear during the first step of the checkout
process. Magento Shipping can be configured to show all options, or only the ones that apply
to the order.
Shipping Methods
During checkout, the shopper identifies the address type as a residence or business, and
specifies whether the carrier must obtain a signature, or can leave the package at the door.
Finally, the shopper chooses the preferred shipping rate and carrier to be used for the order.
During checkout, the “Pick up in store” option appears under Shipping Methods. When
selected, a list of possible pickup locations appears, according to the logic of the related
shipping experience rule. The customer chooses the most convenient location, and selects Click
& Collect as the shipping method.
During Order Review, the Click & Collect location appears in the Ship To section, rather than
the customer’s shipping address.
The customer is notified by email when the order is ready to collect at the designated location.
Collection Points
Collection points allow the customer to specify where the order is shipped. If enabled in the
configuration, specific locations can be designated as fulfillment centers where the order is sent.
The list of available countries is determined by those specified for collection points in the
Magento Shipping configuration.
During checkout, the “Send to Collection Point” option appears under Shipping Methods. When
selected, a list of possible pickup locations appears that are within a 20 km radius of the
customer location, according to the logic of the related shipping experience rule. The list is
sorted by the shortest distance, followed by description and opening hours, if available. Any
locations with distances that cannot be calculated are listed alphabetically.
After choosing the location, the customer is prompted to choose the collection point as the
shipping method.
During Order Review, the collection point location appears in the Ship To section, rather than
the customer’s shipping address.
Returns
When creating a return shipment, you can generate a list of shipping quotes, and choose the
carrier that you want to use. The return label can be included in the original shipment.
To access the Magento Shipping Portal, you must have both a Magento account and a Magento
Shipping account. Your access to the Magento Shipping portal is based on your Magento
account ID.
1. On the Admin sidebar, choose Stores. Then under Settings, choose Configuration.
3. Expand the Magento Shipping section. Then, click Access the Magento Shipping Portal here.
4. When prompted, enter the Email and Password that you use to log in to your Magento
account.
5. Follow the onscreen instructions to request a shipping account. When you receive email
confirmation, follow the instructions to complete the process.
1. When you receive the confirmation email, open a tab to a separate browser window, and log in
to your Magento Shipping account.
You should now have an open tab to your Magento configuration, and another to your
Magento Shipping account. Information from your Magento Shipping account will later be
pasted into the Magento Shipping configuration in the Admin.
3. In the header, click the question mark (?) to hide the Welcome message and Getting Started
steps.
4. The Account Details section shows your API Endpoint and Account ID. This information will
later be copied and pasted into your Magento configuration.
Account Details
5. A unique API token is used to identify the connection between your Magento website and your
Magento Shipping account.
In the API Tokens section, tap Generate Token for the type of token that you need.
Production Generates the API token that is needed to use Magento Shipping in
API Token production mode.
Test API Token Generates an API token that is needed to use Magento Shipping in test
mode.
For a first-time setup, choose Test API Token. When you are ready to “go live” with Magento
Shipping, you can use the Production API Token. In the next step you will paste the token into
the Magento configuration.
API Tokens
Return to the browser tab with the Magento Shipping configuration, and do the following:
2. Enter the Title that you want to use for Magento Shipping.
3. By default, only API errors are logged. If you prefer to log all API communication, set Enable
API Logging to “Yes.”
4. Paste the following credentials from your Magento Shipping account. You will need to return to
the browser tab that is open to Magento Shipping, and copy and paste each into the Magento
configuration.
l API Endpoint
l Account ID
l API Token
To run Magento Shipping in a testing environment, make sure to generate and copy the test token,
rather than the production token.
5. If your store offers return merchandise authorization, set Enabled for RMA to “Yes.”
6. To give customers the option to have the shipment delivered to a designated drop point other
than the standard “ship to” address, set Enable Collection Points at Checkout to “Yes.” Then,
choose each country where such alternate collection points are to be available. (Hold down the
Ctrl key and click each country.)
7. To allow customers to purchase online, but pick up the order at a designated location, set
Enable Click and Collect at Checkout to “Yes.”
All Allowed Customers from all countries specified in your store configuration
Countries can use Magento Shipping.
Specific Countries Select each country in the list where Magento Shipping can be used.
Yes Always shows the Magento Shipping method, even when not
applicable.
c. In the Displayed Error Message box, type the message to appear if Magento Shipping
becomes unavailable.
d. Enter a Sort Order number to determine the position of Magento Shipping in the list of
shipping methods during checkout. (0 = first, 1 = second, 2 = third, and so on.)
Magento Shipping
The Checkout View Settings determine the options that appear as add-on delivery options
during checkout.
a. Enter the text that you want to use as the Dropdown Label for the Address Type
options during checkout.
b. In the Dropdown Options list, select each option that you want to include as an
address type.
c. Select the option that you want to be used as the Default Value.
Address Type
4. In the Authority to Leave section, enter the Checkbox Label for the option.
Authority to Leave
5. In the Signature Required section, enter the Checkbox Label for the option.
Signature Required
6. When complete, tap Save.
Advanced Settings
The following settings are required to synchronize your store with the Temando API to enable
batch processing.
When the initial configuration is complete, you can access the Magento Shipping Portal
directly from the Magento Admin. You can use either of the following methods to access and
complete the shipping profile information from the Magento Admin.
The Magento Shipping portal session times out after thirty minutes of inactivity.
l Carriers
l Locations
l Packaging
l Experiences
Method 2: Configuration
1. On the Admin sidebar, choose Stores. Then under Settings, choose Configuration.
2. In the panel on the left under Sales, choose Shipping Methods. Then, scroll down to the
Magento Shipping section. The shipping profile settings are at the end of the section.
3. Tap Configure to complete each profile. Then, follow the instructions to complete the Location,
Carrier, and Package information.
4. When the profiles are complete, create Shipping Experience Rules to add logic and automate
parts of your shipping workflow.
Shipping Profiles
Locations
The Locations grid lists the available shipping locations, and can include stores, warehouses,
drop shippers, and company headquarters. Existing shipping locations can be edited or
removed, and new shipping locations added. The locations that you enter appear in a drop-
down list for each Shipping Partner profile, to identify the locations where the carrier is
available.
Locations
a. Enter the Location Name, as you want it to appear throughout Magento Shipping.
l Store
l Warehouse
l Drop Shipper
l Headquarters
c. To enable Click & Collect, set Enable Click & Collect to “Yes.”
d. To make this the default pickup location for all shipments, set Set as Default Location to
“No.”
When creating a new shipment, the default location is entered automatically, but can be
changed as needed.
Basic Settings
3. Complete the fields in the Address section. If you need help, click the Help ( ) button, or
refer to the Field Descriptions at the end of this topic.
4. In the Dependent Locality field, enter an additional descriptive name to describe the location,
such as the name of the neighborhood, small town, or suburb.
5. See the Latitude/Longitude FInder to get the GPS coordinates of the location. Then, enter the
Latitude and Longitude coordinates.
Address
6. Complete the fields in the Contact section. If you need help, click the Help ( ) button, or refer
to the field descriptions at the end of this topic.
Contact
Field Descriptions
FIELD DESCRIPTION
Location Name The name that is used to refer to the shipping location throughout the
Admin and storefront.
Enable Click & Collect Determines if the location can be used as a collection point for Click
& Collect fulfillment. Options: Yes / No.
Set as Default Location Identifies the location as the default for all shipments. When creating
a shipment, the default location can be overidden as needed.
Options: Yes / No.
ADDRESS
State / Province The state or province where the shipping facility is located.
Zip / Postal Code The ZIP or postal code where the shipping facility is located.
Dependent Locality An additional description of the location, such as the name of a small
town or suburb.
Longitude The GPS longitude coordinate of the shipping facility. Use the
Latitude/Longitude Finder to get the GPS longitude coordinate of your
location.
Latitude The GPS latitude coordinate of the shipping facility. Use the
Latitude/Longitude Finder to get the GPS latitude coordinate of your
location.
CONTACT
Person First Name The first name of the primary contact at the shipping location.
Person Last Name The last name of the primary contact at the shipping location.
Tax Identification Number The Tax Identification Number assigned to the contact organization,
if applicable. For example, TFN (Australia), TIN (France).
Email The email address of the primary contact at the shipping location.
Shipping Partners
Carrier profiles for Magento Shipping are managed from the Stores menu. New connections to
carriers can be added, and existing connections can be edited or deleted from the Shipping
Partners grid.
In the United States, United Kingdom, and Australia, Magento Shipping supports FedEx pre-
negotiated rates, and ad-hoc returns for FedEx, USPS, Australia Post, UK Mail, and DHL
Express.
For the following countries, Magento Shipping carrier support is currently limited to DHL
Express: Austria, Brazil, Canada, Denmark, France, Germany, Italy, Japan, Netherlands,
Norway, Russia, Spain, Sweden, and Switzerland. Support for additional carriers will be
available soon.
Shipping Partners
1. On the Admin sidebar, choose Stores. Then under Shipping, choose Carriers.
Available Carriers
3. Under Available Carriers, scroll down to find the shipping partner that you want to add. For a
description of services, click Show more.
Shipping Partners
5. Complete each step as follows. Your progress is tracked at the top of the page.
If you do not have an account, you are instructed to contact the carrier. When your account is
ready, return to this step and continue.
a. Under Step 1, choose “Yes” if you have an account with the carrier. Then, tap Next.
b. Some carriers require that you accept the terms of a license agreement. If applicable, read
the License Agreement. To continue, mark the I accept checkbox, and tap Next.
c. Under Step 3, enter your carrier Account Number. Then, complete the information in the
Shipping Address and User Contact and Address sections. This information must match
the information in your carrier account.
1. Find the carrier in the Shipping Partners grid. Then in the Action column, select Configure.
Field Descriptions
FIELD DESCRIPTION
Carrier Connection The name that is used for the carrier during checkout.
Nickname
Locations Identifies each shipping location that can be used by the carrier.
Packaging
The Packaging grid lists the available packaging options that are available through your store.
Existing packaging profiles can be edited or removed, and new packaging profiles added. The
packaging options appear in a dropdown for each Shipping Partner profile, and identify each
type of packaging that is supported by the carrier.
Packaging
To add a package:
1. On the Admin sidebar, choose Stores. Then under Shipping, choose Packaging. Then, do the
following:
d. In the Tare Weight field, enter the weight of the empty package. Then, set Tare Unit to the
unit of measurement that is used for the Tare Weight value.
e. Enter the Maximum Weight that can be placed in the package. Then, set Maximum
Weight Unit to the unit of measurement that is used for the Maximum Weight value.
Basic Settings
2. Complete the fields in the Outer Dimensions section. If you need help, click the Help ( )
button, or refer to the Field Descriptions at the end of this topic.
Outer Dimensions
3. Complete the fields in the Inner Dimentions section. If you need help, click the Help ( )
button, or refer to the Field Descriptions at the end of this topic.
Inner Dimensions
Field Descriptions
FIELD DESCRIPTION
Name The name of the packaging type.
Tare Weight The weight of the empty container that is used to calculate the
shipment load when added to content weight.
Tare Weight Unit The unit of measurement that is used to describe tare weight.
g Gram
oz Ounce
kg Kilogram
lb Pound
Maximum Weight The maximum weight allowed for this packaging type.
Maximum Weight Unit The unit of measurement that is used to describe the maximum
weight.
g Gram
oz Ounce
kg Kilogram
lb Pound
OUTER DIMENSIONS
Unit Determines the unit of measurement for the outer dimensions of the
package. Options:
cm Centimeter
in Inch
m Meter
mm Millimeter
ft Foot
INNER DIMENSIONS
Unit Determines the unit of measurement for the inner dimensions of the
package. Options:
cm Centimeter
in Inch
m Meter
mm Millimeter
ft Foot
Because most shipping experience rules reference information from the Locations, Shipping
Partners, and Packaging configuration, you should complete the basic setup of each profile
before creating rules.
Shipping Experience
Shipment Workflow
Your customer is ready to check out their cart.
l Qualify Rules
l Allocation Rules
l Quoting Rules
l Fulfillment Rules
Shipment is dispatched.
Delivery arrives.
The following instructions show how to create a Qualify rule; however, the process is essentially
the same for all shipping experience rules. First, describe the condition, then, choose an
operator, and define the action to be taken. You can follow these basic instructions to create
any type of rule. Refer to the field descriptions for more information about different rule types
and options.
Shipping Experiences
b. For now, accept the default Status of “Draft.” When you are ready to “go live” with the rule
in your store, you can change Status to “Production.”
c. Choose the type of rule that you want to create. In the rule section, tap Create Rule. Then,
do the following:
This example shows how to create a Qualify Rule. Notice the icon and note before each
section is mapped to the corresponding step in the shipment workflow.
Create Rule
d. Enter a brief Description of the rule that states its purpose and the conditions that trigger
the rule.
Description
3. In the Conditions section, choose the Condition that must be met to trigger the rule.
Think about conditions that are required to trigger the rule. For example, the condition might
be, “Country is China,” or “Country is not China.” You can also combine multiple conditions,
such as, “Country is China or Hong Kong,” or “Country is China and order items total weight is
less than 50 pounds (lb).”
Conditions
4. Choose the Operator that is needed to describe the condition. Then, do the following:
Choose an Operator
b. To add another condition, click Add Condition. Then, choose the logical operator that
describes how the conditions are to be applied.
AND Triggers the rule when both the previous condition and the new condition
are met.
OR Triggers the rule when either the previous condition, or the new condition
is met.
Completed Condition
a. Choose the Action that applies when the conditions are met.
Outcomes
The description of the new rule appears in the list of Qualify Rules.
Qualify Rules
Field Descriptions
FIELD DESCRIPTION
Name A descriptive internal reference to identify the rule.
QUALIFY RULES
Qualify Rules Specifies the shipping methods that you want to make available to
customers during checkout, such as Flat Rate, Collection Point, and
Click & Collect.
If more than one qualify rule exists, the first one to have its conditions
met is used.
Conditions Determines the conditions that must be met to trigger the rule. A
simple condition might have two parts (or operands), separated by an
operator. The options for the first part of the expression are listed
below. The options for the second part of the expression vary,
depending upon the first option. For example, if the first part of the
condition is “Destination country,” the second part will be a list of
countries where the condition applies. The Conditions block walks
you through the process of building the condition. and presents the
available options for the condition. Options for the first part of the
condition:
Always
Destination country
Operator The following operators can be placed between the two parts of the
condition. Options:
any of
is
is not
not any of
Use the following logical operators to determine how multiple
conditions are used to trigger the rule.
Outcomes The outcome describes the action that is taken when the condition is
met. The selection of options varies by type of condition. Actions:
ALLOCATION RULES
Conditions Determines the conditions that must be met to trigger the rule.
Options:
Always
Order items with SKU
Order items with name
QUOTING RULES
Quoting Rules Control the carrier service selection. The rule is triggered when you
get quotes while processing an order.
Conditions Determines the conditions that must be met to trigger the rule.
Options:
Always
Destination country
Destination postal code
Packages gross weight
Origin Location Type
Destination Location Type
Signature Required
Authority to Leave
Quote With Carrier In the list, mark the checkbox of each carrier
Services that you want to associate with the action.
Batch Fulfillment Rules Allows you to run automated batch fulfillment processing.
Conditions Specifies the conditions that must be met to trigger a batch fulfillment
rule. Option: Always
FULFILLMENT RULES
Fulfillment Rules Allows you to override the default carrier service, and choose another
based on a set of conditions.
Conditions Specifies the conditions that must be met to trigger a batch fulfillment
rule. Options:
Destination Location Type
Signature Required
Authority to Leave
Shipment Status
Packed Items with SKU
Packed Items with Name
Operator (Same as for Qualify Rules, although selection might vary for
condition.)
Every Click & Collect order generates a pickup record. Like a shipment, the pickup record is
associated with the specific order. The main difference between the two is that a pickup does
not have packaging or quote/booking requirements. Because Click & Collect is available only
from the storefront, it cannot be used for orders that are created from the Admin.
The pickup location that a customer chooses during cannot be changed from the Admin.
2. Create a Qualify Shipping Experience Rule with the outcome set to “Offer click and collect
locations.” The rule can be configured to offer one or more locations. If the Click & Collection
location is set to “All,” any new locations appear to the customer during checkout.
3. In the Magento Shipping configuration, set Enable Click and Collect to “Yes.”
The first step to fulfill a pickup is to navigate to the Pickups page. The Pickups grid lists all
pickups that have been created.
The Pickups grid can be filtered by a variety of fields, with the main used being Origin Location
and Status. Any filter settings made by the Admin user are retained for that user’s future
sessions.
If you have multiple locations, it is recommended that you filter the grid by Origin Location to
ensure that only orders which are to be picked up at your location listed. You can also filter the
list based on a Status field value of “Pickup Requested” to ensure that the list includes only
new pickup records that are not yet in process.
To print packing slips for all filtered pickups, choose Select All, and set the Action control to
:Print Packing Slips.”
The packing slips are downloaded as a single PDF file, which can be printed immediate, or
saved and printed later. Each packing slip contains the customer details, the products ordered,
and a barcode that references the pickup.
When the orders have been picked and set aside, they are marked “Ready for Pickup.” The
customer is notified by email that their order is ready for pickup.
To prevent duplication, any items included in pickups that are marked “Ready for Pickup” are
not available to be allocated to a package.
5. After the customer picks up the package at the designated location, change the status in the
upper-right corner of the pickup record to “Picked Up.”
l An email is sent to notify the customer that the order is ready to collect.
l The Pickup page closes, and you return to the Pickups grid.
Tap Ready for Pickup to initiate the partial pickup process. The following events take place:
l An email is sent to notify the customer that the specified items are ready to collect.
l A new pickup record with a status of “Pickup Requested” is created for the remaining items.
l The Pickup page closes, and you return to the Pickups grid.
The remaining pickup items can be fulfilled as either a separate pickup or shipment when the
items become available.
After the customer collects the items, the pickup record is marked, “Picked Up,” and an email
is sent to the customer to confirm that the items have been fulfilled.
To cancel a pickup:
Open the pickup record, and tap Cancel Pickup.
l If the status of the pickup was “Ready for Pickup,” the items are returned to inventory.
l The customer is notified by email that the pickup has been canceled.
Collection Points
Collection points allow a customer to place an order online and have it shipped to a designated
collection point, rather than to their address. For a description of how collection points are
specified during checkout, see: Customer Experience.
From a Merchants perspective, you have full control over which carrier’s collection points will
be made available to customers in the checkout. The fulfilment workflow is the same as
Shipments.
There are two areas of configuration that need to be completed before Customers can start
nominating that an order be shipped to a Collection Point.
Create a Qualify rule that offers collection point locations during checkout. The collection
points can be specified per carrier, but are combined into a single list for the customer.
All Carriers
This is the default filter for offering collection point locations. If a rule is configured in this
fashion, new carriers that are configured which support collection points will automatically be
presented to a customer without having to update the experience rule.
Specific Carriers
A rule can be configured to include a selection of one or more carriers. For example, you might
use this to apply different flat rate shipping rates per carrier, depending on the collection point
selected.
When enabled, the “Send to Collection Point” configuration setting causes the collection point
option to be included under Shipping Methods during checkout.
Troubleshooting
Fail to Book
Before you can offer your customers a selection of shipping carriers, you must first complete the
shipping settings to establish the point of origin for your store. Then, complete the
configuration for each carrier service that you want to offer. The configuration options vary for
each carrier. However, all require that you first open a shipping account with the carrier, and
enter your account number or user ID, and the gateway URL to their system into the
configuration of your store. See Magento Marketplace for additional shipping services for your
Magento Commerce installation.
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.
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 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.
The country of manufacture is required for all products that are shipped internationally by
USPS and FedEx, If you have many products that need to be updated, you can either import
the updates, or use the Inventory grid to update multiple records.
1. On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.
a. In the grid, find the product to be updated, and open in edit mode.
Country of Manufacture
a. In the grid, mark the checkbox of each product to be updated. For example, all products
that are manufactured in China.
c. In the Update Attributes form, find the Country of Manufacture field and mark the
Change checkbox. Then, choose the country.
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 The street address of the place from which shipments are sent. For
example, the location of your company or warehouse. This field is
required for shipping labels.
Street Address Any additional address information, such as the floor, entrance and
Line 2 so on. We strongly recommend that you use this field.
Origin
b. In the panel on the left under Sales, choose Shipping Methods. Then, expand the
USPS section, and verify that the following fields are complete:
Password The password is provided by USPS, and gives you access to their
system through Web Services.
Length, Width The default dimensions of the package. To make these fields
Height, Girth 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
This information is provided by the carrier, and is required to gain access to their system
through Web Services.
d. In the panel on the left under General, choose General. Expand the Store Information
section, and verify that the following fields are complete:
Store Contact The telephone number of the primary contact for the store or store
Telephone view.
VAT Number If applicable the Value Added Tax number of your store. (Not
required for stores based in the U.S.)
Store Contact The street address of the primary contact for the store or store view.
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.
Store Information
Carrier Requirements
CARRIER REQUIREMENTS
USPS Requires a USPS account. As of February 23, 2018, USPS requires all
shipping labels to include postage.
UPS Requires a UPS account. Shipping labels are available only for shipments
that originate in the U.S. Specific credentials are required for stores outside
the US.
FedEx Requires a FedEx account. For stores outside of the U.S., shipping labels
are supported for international shipments only. FedEx does not allow
domestic shipments that originate outside of the U.S
DHL Requires a DHL account. Shipping labels are supported only for shipments
that originate in the U.S.
Process Overview:
Step 1: Contact Your Shipping Carriers
Step 2: Update the Configuration for Each Carrier
Step 3: Create Shipping Labels
Step 4: Print the Labels
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 Contact FedEx Web Services regarding their label evaluation process.
UPS Contact UPS to confirm your account type supports shipping labels. To
generate shipping labels, you must use the UPS XML option.
DHL Contact the DHL Resource Center to learn more about their services or send
an inquiry through their Contact Center.
2. Follow the instructions below for each carrier account that has been activated for label printing.
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.
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.
USPS Configuration
The United States Postal Service ships both domestically and internationally.
1. Continuing in the Shipping Methods configuration, expand the USPS section. Then, do
the following:
a. Verify that the Secure Gateway URL is entered. The correct URL should be entered
automatically.
l Length
l Width
l Height
l Girth
FedEx Configuration
FedEx ships domestically and internationally. Stores located outside the United States can
create FedEx labels for international shipments only.
1. Continuing in the Shipping Methods configuration, expand the FedEx section. Then,
make sure that the following FedEx credentials are correct:
l Meter Number
l Key
l Password
DHL Configuration
1. Continuing in the Shipping Methods configuration, expand the DHL section. Then, do the
following:
a. Verify that the Gateway URL is entered. The correct URL should be entered automatically.
l Access ID
l Password
l Account Number
Process Overview:
Method 1: Create Label for New Shipment
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 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.
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.
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.
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.
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.
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
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.
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.
4. Tap Submit.
A complete set of shipping labels is printed for each shipment that is related to the selected
orders.
Customs Value (International shipments only) The declared value or sales price of the
contents of an international shipment.
Total Weight The total weight of all products added to the package is calculated
automatically. The value can also be changed manually, and entered
as pounds or kilograms.
Length, Width, Height (Optional) The package dimensions are used for custom packages
only. You can specify the measurements units as inches or
centimeters.
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.
After products are added to the package, the quantity cannot be edited directly.
The number is added to the previous quantity of the product in the package.
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.
If you need to stop the process, tap Cancel. The packages are not saved, and the shipping label
process is canceled.
Field Descriptions
FIELD DESCRIPTION
Type 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.
Total Weight The total weight of a package. The field is pre-populated with the total
weight of products in a package. The unit of measurement can be set
to either pounds or kilograms.
Length The length of a package, integer and floating point numbers. The field
is enabled if the custom package type is used. The unit of
measurement can be set to either inches or centimeters.
Height The height of a package, integer and floating point numbers. The field
is enabled if the custom package type is used. The measurement
units can be specified using the drop-down menu next to the Height
field; select between inches and centimeters.
2012
Contents
In this section of the guide, you will learn how to Reports Menu
filter data and online generate reports. The report
data can be opened in a spreadsheet or imported Statistics
into other applications. Marketing
Reviews
Sales
Customers
Products
Private Sales
2013
CHAPTER 99:
Reports Menu
Magento Commerce provides a wide selection of reports to keep you informed on your
marketing efforts, sales products, and customer activity. The Reports menu provides easy
access to current information about your sales, products, customers, and promotions.
Reports Menu
Menu Options
Marketing
A selection of marketing reports, including Products in Cart, Search Terms, Abandoned Carts, and
Newsletter Problem Reports.
Reviews
The selection of product review reports includes By Customer and By Product.
Sales
The selection of sales reports includes Orders, Tax, Invoiced, Shipping, Refunds, Coupons, and settlement
reports for PayPal and Braintree.
Customers
The selection of customer reports includes Order Total, Order Account, New, Wish Lists, and Segments.
Products
The selection of product reports includes Views, Bestsellers, Low Stock, Ordered, and Downloads.
Private Sales
The selection of reports for private sales and events includes Invitation, Invited Customers, and
Conversions.
Statistics
Statistics is a tool that reduces the performance impact of generating reports by calculating and storing
statistical data. Rather than recalculate the statistics every time a report is generated, the stored statistics
are used until you refresh the statistics.
Business Intelligence
The Advanced Reporting dashboard gives you valuable insight with a dynamic set of product, order, and
customer reports, powered by Magento Business Intelligence. for more sophisticated reporting and
analysis, sign up for a free trial of BI-Essentials.
Refresh Statistics
To reduce the performance impact of generating sales reports, Magento calculates and stores
the required statistics for each report. Rather than recalculate the statistics every time a report
is generated, the stored statistics are used, unless you refresh the statistics. To include the
most recent data, the report statistics must be refreshed before a sales report is generated.
Refresh Statistics
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.
l By Customers
l By Products
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.
Shipping Report
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.
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.
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.
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. With Inventory Management
enabled, the report includes low stock inventory amounts
per source with the listed source code.
Ordered Products
The Ordered Products Report lists all products ordered
for a specified time interval or date range. The report
includes the product name and quantity ordered.
Downloads
The Downloads Report lists all downloads during the
specified time interval or date range. The report includes
the product name, download link, and SKU, with the
number of purchases and downloads.
CHAPTER 105:
Private Sales Reports
The Private Sales Reports provide information about events and private sales.
Invitations Report
Reports
Invitations
The Invitations Report shows the number of invitations
sent during the specified time period, and the number
accepted, and discarded.
Invited Customers
The Invited Customers Report shows all customers who
have been sent invitations to a private sale or event, and
includes the name and email address, customer group,
and the number of invitations sent and the number
accepted.
Conversions
The Conversions Report shows the number of invitations
sent and accepted, the number of invitations that led to a
purchase, and the conversion rate as a percentage.
2. In the menu under Marketing Automation, choose one of the following reports:
l Importer Status
l Automation Enrollment
l Campaign Sends
l Cron Tasks
l Dashboard
l Log Viewer
l Abandoned Carts
2035
Contents
Magento advanced reporting and business Advanced Reporting
intelligence tools give you the insight you need
to make sound business decisions. Analyze Magento BI Essentials
your top-performing customers, products, and New Relic Reporting
promotions to find new opportunities for
growth. Then, share the insights across your
organization with just a few clicks.
2036
CHAPTER 107: Advanced Reporting
Advanced Reporting gives you access to a suite of dynamic reports that are based on your
product, order, and customer data, with a personalized dashboard that is tailored to your
business needs. Advanced Reporting is a free, cloud-based service that is powered by Magento
Business Intelligence.
Requirements
The website must run on a public web server.
In the Magento configuration, the Base URL (Secure) setting for the store view must point
to the secure URL. For example https://yourdomain.com
In the Magento configuration, Use Secure URLs on Storefront, and Use Secure URLs in
Admin must be set to “Yes.”
Make sure that Magento crontab is created and cron jobs are running on the installed server.
The initial release of Advanced Reporting supports only one base currency.
1. On the Admin sidebar, choose Stores. Then under Settings, choose Configuration.
2. In the panel on the left, choose General. Then under Advanced Reporting, do the following:
a. Verify that Advanced Reporting Service is set to “Enable.” (This is the default setting.)
b. Set the Time of day to send data to the hour, minute, and second, according to a 24-hour
clock, that you want the service to receive updated data from your store. By default, data
is sent at 2:00 AM.
c. Under Industry Data, choose the Industry that best describes your business.
Advanced Reporting
4. When prompted, click the Cache Management in the message at the top of the page. Then,
refresh any invalid caches.
5. Wait overnight, or until after the time of your next scheduled update. Then, check the status of
your subscription. If the status is still “pending,” make sure that your installation meets all of
the requirements.
l On the Admin sidebar, choose Reports. Then under Business Intelligence, choose
Advanced Reporting.
The Advanced Reporting dashboard provides a quick summary of your orders, customers, and
products. Make sure to scroll down to see the full dashboard.
2. To get a better view of the data, set the Filters in the upper-right corner to the time period and
store view that you want to include in the report. Then, do the following:
Data Point
1. In the upper-right corner of the Advanced Reporting dashboard, click Additional Resources.
Troubleshooting
If you get a 404 “Page Not Found” message, verify that your store meets the requirements for
Advanced Reporting. Then, follow the instructions to verify that the integration is installed.
2. Verify that the Magento Analytics user integration appears in the list, and that the Status is
“Active.”
Reauthorize
b. Verify that the list of Integration Tokens for Extensions is complete. Then, tap Done.
Integration Tokens
4. Look for the message that indicates the integration “Magento Analytics user” has been
reauthorized.
5. Wait overnight, or until after the time of your next scheduled update.
Dashboard Reports
FIELD DESCRIPTION
ORDERS
Revenue Shows all revenue received by the store view during the defined time
period.
Orders Shows all orders placed through the store view during the defined
time period.
AOV Shows the average order value placed through the store view during
the defined time period.
Refunds Shows all refunds processed through the store view during the
defined time period.
Tax Collected Shows all tax collected through the store view during the defined time
period.
Shipping Collected Shows all shipping fees collected through the store view during the
defined time period.
Orders by Status Shows the number of orders by status, for the store view during the
defined time period.
Orders and Revenue by Lists the number of orders and revenue by region for the store view
Billing Region during the defined time period.
Tax Collected by Billing Lists the amount of tax collected by region for the store view during
Region the defined time period.
Shipping Fees Collected Lists the shipping fees collected by region for the store view during
by Shipping Region the defined time period.
CUSTOMERS
Unique Customers Shows the number of unique customer accounts associated with the
store view during the defined time period.
New Registered Accounts Shows the number of new customer accounts registered with the
store view during the defined time period.
Top Coupon Users Lists the top coupon users by Customer ID, and the number of orders
placed with coupons for the store view during the defined time period.
Customer KPI Table Lists the number of orders, revenue, and average order value by
Customer ID for the store view during the defined time period.
PRODUCTS
Quantity of Products Sold Shows the number of products sold through the store view during the
defined time period.
Products Added to Lists all products added to wishlists through the store view during the
Wishlists defined time period.
Best Selling Products by Lists the best-selling products and quantity sold through the store
Quantity view during the defined time period.
Best Selling Products by Lists the best-selling products and revenue generated by the sale of
Revenue the product through the store view during the defined time period.
When you activate a Magento BI Essentials account, you get access to five dashboards with
approximately 100 reports. These reports are designed to provide insights around your data
and answer questions like: “How are my orders growing month-over-month? Who are my most
loyal customers? Is my coupon strategy working?”
l If you are a Magento Commerce Cloud Pro subscriber, please reach out to your Customer
Success Manager to set you up with your entitled BI Essentials account.
l If you are a Magento Commerce Cloud Starter subscriber, refer to this support article for
information about activating your entitled BI Essentials account.
l If you are a Magento Commerce On-Prem subscriber, use the following information to
activate your account and access BI Essentials.
The instructions in this section walk you through the activation, and introduce some basic
features of Magento BI Essentials. For more detailed information, refer to the Magento BI Help
Center.
2. Select the My Account tab. Then choose My MBI Instances in the side navigation.
4. Select the subscription for the instance creation (if you have only one active Magento
subscription, this is selected by default). Then, tap Continue.
Create Account
6. Check your email for a Welcome message from the Magento BI Team, with your log-in
credentials. To learn more, see the Essentials Quick Start Video Series.
2. In the upper-right corner, click Additional Resources. Then under Magento Business
Intelligence, choose Magento BI Website.
2. Enter your Email Address and Password. Then, tap Sign In.
Sign In to Magento BI
Dashboards
BI Dashboards give you a quick view of your store’s performance and sales activity at a glance.
Individual dashboards can be shared with other users, and organized into logical groups. You
can also set different levels of permission to others users.
It’s easy to create a new report, add it to a dashboard, and export the data to Excel. Charts and
reports can be resized and dragged into position on the dashboard.
Dashboard
2. The name of the default dashboard appears in the upper-left corner of the dashboard header.
Click the down arrow ( ) to show the available options.
Create Dashboard
b. To create a new Group for the dashboard, enter the name of the group.
For example, if your Magento installation has multiple store views, you might create a
Group for each store view.
c. Tap Create.
Dashboard Name
d. The name of your new dashboard appears in the upper-left corner. Click the down arrow to
show the options. If you created a group, the new dashboard appears below the group in
the list.
Add Report
l To move a chart or report, hover over the title or header until the cursor changes to a cross.
Then, drag it into position.
1. On the menu, choose Manage Data. Then in the sidebar, choose Dashboards.
3. To assign the dashboard to a specific Dashboard Group, choose from the list of groups.
Permissions
To give all users the same level of access to the dashboard, do the following:
l View
l Edit
l None
2. When prompted for confirm, tap OK to update the permissions level for each user.
3. To change the permission level of an individual, find the user in the list change the
permission level. The change is automatically saved.
4. To make this dashboard the default for your BI Essentials account, tap Make Default.
Report Builder
The following example shows how to create a simple report, group the data by an additional
dimension, set the date and time interval, change the chart type, and save the report to a
dashboard.
2. Under Visual Report Builder, tap Create Report. Then, do the following:
b. Choose the metric that describes the set of data that you want to use for the report.
The New Customers metric used in this example counts all customers, and sorts the list by
the date the customer signed up for an account. The initial report includes a simple line
graph, followed by the table of data.
The summary on the left shows the name of the current metric, followed by the result of
any calculations on column data that are specified in the metric. In this example, the
summary displays the total customer count.
3. In the chart, hover over each data point on the line. Each data point shows the total number of
new customers who signed up during that month.
4. Follow these instructions to group the data, change the date range, and chart type.
Group By
The Group By control gives you the ability to add multiple dimensions by group or segment.
Dimensions are columns in the table that can be used to group the data.
1. Choose one of the available dimensions from the list of Group By options.
For this example, the system found five coupon codes that were used by customers while
placing their first order.
Group by
2. The Group By detail lists each coupon used by customers. The coupons that were used to
place the initial order are marked with a checkbox The chart now has multiple colored
lines that represent the each coupon that was used for a first order. The legend is color-
coded to correspond to each row of data.
Multiple Dimensions
3. Hover over a few data points on each line to see the number of customers during the
month who used that coupon while placing their first order.
4. The table of data now has an addition dimension, with a column for each month, and a
row for each coupon code.
5. Click the Transpose ( ) control in the upper-right corner of the table to change the
orientation of the data.
The axis of the data is flipped, and the table now has a column for each coupon code, and
a row for each month. You might find this orientation easier to read.
Transposed Data
Date Range
The Date Range control shows the current date range and time interval settings, and is located
just above the chart to the right.
1. Click the Date Range control, which in this example is set to “All-Time by Month.”
Date Range
2. Make the following changes:
a. To zoom in for a closer view, change the date range to Last Full Quarter.
The report now includes only the data for the last quarter, by week.
Chart Type
Click the controls in the upper-right corner to find the best chart for the data.
Line graph
Horizontal Bar
Vertical Bar
Pie
Area
Funnel
5. To give the report a title, replace the “Untitled Report” text at the top of the page with a
descriptive title.
Save to Dashboard
l In the menu, choose Dashboards. Click the name of the current dashboard to display the
list. Then, click the name of the dashboard where the report was saved.
Report in Dashboard
Filters
One or more filter(s) can be added to limit the data that is used to product a report. Each filter
is an expression that includes a column from the associated table, an operator, and a value. For
example to include only repeat customers, you might create a filter that includes only
customers who have placed more than one order. Multiple filters can be used with logical
“AND/OR” operators to add logic to the report.
A report can have a maximum of 3,500 data points. To reduce the number of data points, use a filter
to reduce the amount of data that is used to generate the report.
Magento BI includes a selection of filters that you can use “out of the box,” or modify to suit
your needs. There is no limit to the number of filters you can create.
To add a filter
1. In the chart, hover over each data point. In this report, each data point shows the total number
of customers for the month.
Add Filter
Filters are numbered alphabetically, and the first is [A]. The first two parts of the filter are
drop-down lists of options, and the third part is a value.
a. Click the first part of the filter, and choose the column that you want to use as the subject
of the expression.
b. Click the second part of the filter, and choose the operator.
c. In the third part of the filter, enter the value that is needed to complete the expression.
The report now includes only repeat customers, and the number of customer records
retrieved for the report has been reduced from 33K to 12.6k.
Filtered Report
Perspective
Cumulative Perspective
The Cumulative perspective distributes the change over time, rather than showing the jagged
up and downs for each month.
6. Enter a Title for the report. Then, Save it as a Chart to your dashboard.
Save to Dashboard
Formulas
A formula combines multiple metrics and mathematical logic to answer a question. For
example, how much of the revenue per product during the holiday season was generated by
new customers?
2. Tap Add Metric, and choose the first metric for the report.
3. Tap Add Metric again, and choose the second metric for the report.
5. In the sidebar, click the name of each metric to open the settings page in a new browser tab.
Scroll down to see each component of the metric, including the metric query, filter, and
dimensions.
Metric Settings
7. In the chart, hover over a few data points on each line to see the amounts associated with each
metric.
The formula box shows the metrics as available inputs A and B, and includes an input box
where you can enter the formula.
Do the following:
This will divide the revenue by products ordered by the number of new customers.
Formula Settings
The report now has a new line for the formula, “New Customer Revenue,” and the sidebar
shows the total amount of revenue generated by new customers.
For this example, the holiday season is from November 1 through December 31.
The report is now limited to the holiday season, with a data point for each day.
1. Click the “Untitled Report” text at the top of the page, and enter a descriptive title. For this
example, the report title is “2017 Holiday Sales.”
2. Click the report title, and change the name. For this example, the report title is changed to
“2017 Holiday Sales Data”
l In the menu, choose Dashboards. Click the name of the current dashboard to display the
list. Then, click the name of the dashboard where the report was saved.
Manage Data
Manage Data provides access to a variety of tools for managing integrations, report and chart
data, dashboards, and exports.
2. In the sidebar, choose the topic that you want under the following headings:
l Data Sources
l Manage Data
l Export Data
Manage Data
Metrics
Each report includes at least one query that defines the set of data, or “metrics” for the report.
The metrics statement describes the data that is to be retrieved, and consists of an operator,
column, table, and sorting order. Magento BI includes a set of default, “out of the box” metrics
that can be easily customized. You can create an unlimited number of custom metrics.
Metrics
3. Click the name of any metric to display detailed information. To show the Metric Options,
click the Settings ( ) icon on the right.
Metric Detail
Metrics
New Customers
Count on the entity_id column in the customer_entity table
(Change) ordered by the created_at (use) column
Registered accounts
Count on the entity_id column in the customer_entity table
(Change) ordered by the created_at (use) column
customer_group
New Metric
Count on the customer_group_id column in the customer_group
table (Change) ordered by the [NONE] column
sales_flat_order
New Metric 2
Count on the entity_id column in the sales_flat_order table
(Number of orders) (Change) ordered by the [input] created_at (use) column
Orders
Count on the entity_id column in the sales_flat_order table
(Change) ordered by the [input] created_at (use) column
Revenue
Sum on the base_grand_total column in the sales_flat_order table
(Change) ordered by the created_at (use) column
Shipping
Sum on the base_shipping_amount column in the sales_flat_order
table (Change) ordered by the created_at (use) column
Tax
Sum on the base_tax_amount column in the sales_flat_order table
(Change) ordered by the created_at (use) column
Unique Customers
Count Distinct Values on the customer_email column in the sales_
flat_order table (Change) ordered by the created_at (use) column
sales_flat_order_item
Revenue by products
Sum on the Order item total value (quantity * price) column in the
ordered
sales_flat_order_item table (Change) ordered by the created_at
(use) column
Metric Options
FIELD DESCRIPTION
Operator Average
Count
Sum
Average
Maximum Value
Minimum Value
Count Distinct Values
Median
First Quartile
Third Quartile
Tenth Percentile
Ninetieth Percentile
Table addresses
categories
customer_entity
customer_group
sales_flat_order
sales_flat_order_address
sales_flat_order_item
customer_group customer_group_id
sales_flat_order base_grand_total
base_shipping amount
base_tax_amount
billing_address_id
Customer’s lifetime number of coupons
Customer’s lifetime number of orders
Customer’s lifetime revenue
customer_id
entity_id
Number of items in order
Seconds between customer’s first order date
and this order
Seconds since previous order
shipping_address_id
store_id
sales_flat_order_ base_price
item Customer’s lifetime number of orders
Customer’s lifetime revenue
item_id
Order item total value (quantity * price)
order_id
product_id
qty_ordered
Filter Sets
A filter set is based on a table, and can include multiple statements with logic to select the data
for a report or chart. Magento BI includes several default filter sets that you can use “as is” or
modify. There is no limit to the number of filter sets that you can create.
A filter set can be applied to any metric that uses the same table. To learn more, see Creating
filter sets for metrics in the Magento BI Help Center.
1. On the menu, choose Manage Data. Then in the sidebar under Manage Data, choose Filter
Sets.
2. Click Expand All to display the detail of each filter set that is currently available.
Filter Sets
1. In the upper-right corner of the Filter Sets page, tap Create New Filter Set. Then, do the
following:
a. Under Select a Table, choose the table upon which the filter set is based.
Select a Table
c. Tap Add Filter. Then, follow the instructions to build each part of the expression.
Add Filter
d. To add another filter, tap Add Filter. Then, build the expression.
e. To complete the Filter Logic, use the AND/OR operators to describe how multiple
statements in the filter are to be applied.
The new filter appears in the list of Available Filter Sets by Table.
Export Data
Raw report data can be exported from the Magento BI data warehouse to a CSV or Excel file.
You can also create a list of raw, exported data from tables that refreshes every 15 seconds to
ensure that the data is always current.
Report Settings
3. Watch the bottom of the window for the export file. Then, open the file.
Choose Table
Choose Columns
d. If you want to add a filter, tap Add Filter. Then, follow the instructions to create a filter
for the exported data.
The filters in this example includes all customers who placed their first order during the
2018 holiday season.
Filters
Look for a message that says the export is successfully queued. The export appears in the list
when the process is complete.
Export List
5. To download the exported data, tap Download. Then, look for the exported zip file at the
bottom of the window.
1. Visit the New Relic website, and sign up for an account. You can also sign up for a free trial
account.
2. Follow the instructions on the site. When prompted choose the product that you want to
install first.
3. While you are in your account, locate the following credentials that you will need to complete
the configuration:
Account ID From your New Relic account dashboard, the Account ID is the number in
the URL after: /accounts
Application ID From your New Relic account dashboard, tap New Relic APM. In the menu,
choose Applications. Then, choose your application. The Application ID is
the number in the URL after: /applications/
New Relic API Key From your New Relic account dashboard, tap Account Settings. In the menu
on the left under Integrations, choose Data Sharing. Your API key can be
created, regenerated, or deleted from this page.
Insights API Key From your New Relic account dashboard, tap Insights. In the menu on the
left under Administration, choose API Keys. Your Insights API Key(s) appear
on this page. If necessary, click the plus sign (+) next to Insert Keys to
generate a key.
2. Follow the instructions to set up the PHP agent on your server. If you need help, see: New Relic
for PHP.
3. Make sure that cron is running on your server. To learn more, see: Configure and run cron.
1. On the Admin menu, tap Stores. Then under Settings, choose Configuration.
2. In the panel on the left under General, choose New Relic Reporting. Then, do the following:
b. In the Insights API URL, replace the percent (% symbol with your New Relic Account ID.
3. In the New Relic Application Name field, enter a name to identify the configuration for
internal reference.
4. Optional, for the Send Adminhtml and Frontend as Separate Apps field, select No (default) or
Yes to send collected data for the storefront and Admin as separate apps to New Relic. This
option requires a name entered for the New Relic Application Name.
Enabling this feature reduces the number of false positive New Relic alerts and allows for
configured monitoring and alerts strictly for frontend performance. New Relic receives separate app
data files with names of Application Name appended to Adminhtml and frontend. For example:
MyStore_Adminhtml
Cron
Admin Events
Active Admin Users
Widget Name: Active Admin Users
SELECT uniqueCount(AdminId)
FROM Transaction
SELECT uniques(AdminName)
FROM Transaction
SELECT count(AdminId)
FROM Transaction
Description: Returns detail information about recent admin actions, including the admin
username, duration, and application name.
FROM Transaction
Cron Events
Category Count
Widget Name: Category Count
Description: Returns the number of application events by category during the specified
time period.
SELECT average(CatalogCategoryCount)
FROM Cron
Description: Returns the average number of application events in the catalog by category
during the specified time period.
SELECT average(CatalogCategoryCount)
FROM Cron
Active Products
Widget Name: Active Products
Description: Returns the number of application events by product during the specified
time period.
SELECT average(CatalogProductActiveCount)
FROM Cron
Description: Returns the average number of active application events by product during
the specified time period.
SELECT average(CatalogProductActiveCount)
FROM Cron
Configurable Products
Widget Name: Configurable Products
SELECT average(CatalogProductConfigurableCount)
FROM Cron
SELECT average(CatalogProductConfigurableCount)
FROM Cron
Description: Returns the total number of application events for all products.
SELECT average(CatalogProductCount)
FROM Cron
Description: Returns the average number of application events for all products during the
specified time period.
SELECT average(CatalogProductCount)
FROM Cron
Customer Count
Widget Name: Customer Count
SELECT average(CustomerCount)
FROM Cron
Description: Returns the average number of customers during the specified time
period.
SELECT average(CustomerCount)
FROM Cron
Module Status
Widget Name: Module Status
Description: Returns the average number of times application modules are enabled,
disabled, or installed during the specified time period.
(ModulesInstalled)
FROM Cron
Description: Returns the average number of times modules were enabled, disabled, or
installed during the specified time period.
(ModulesInstalled)
FROM Cron
Description: Returns the average number of application events by website and store
during the specified time period.
FROM Cron
Description: Returns the average number of current application events during the
specified tim e period.
FROM Cron
SELECT *
FROM Cron
Customers
Description: Returns the number of active customers during the specified time period.
SELECT uniqueCount(CustomerId)
FROM Transaction
Active Customers
Widget Name: Active Customers
Description: Returns the names of active customers during the specified time period.
SELECT uniques(CustomerName)
FROM Transaction
Top Customers
Widget Name: Top Customers
Description: Returns the top customers during the specified time period.
SELECT count(CustomerId)
FROM Transaction
Description: Returns a defined number of records of recent activity, that include the
customername and duration of visit.
FROM Transaction
WHERE appName='<your_app_name>'
Orders
Description: Returns the number of orders placed during the specified time period.
SELECT count(`Order`)
Description: Returns the total number of line items ordered during the specified time
period.
SELECT sum(LineItemCount)
Description: Returns the total number of line items ordered during the specified time
period.
SELECT sum(LineItemCount)
2094
International Tax Guidelines
U.S. Tax Guidelines
Stores Canadian Tax Guidelines
In this section of the guide, you’ll learn how to set EU Tax Guidelines
up a store hierarchy, create attributes, and Warning Messages
manage the settings used by each store to
calculate taxes, and currency rates. Currency
Configuration
Taxes
2095
CHAPTER 110:
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
Menu Options
All Stores
Manage the hierarchy of websites, stores and store
views in your Magento installation, and all configuration
settings. In addition, you can set up the Terms and
Conditions of a sale, and manage order status settings.
Taxes
Set up the tax rules for your store, define customer and
product tax classes, and manage tax zones and rates.
You can also import tax rate data into your store.
Currency
Manage the rates for the currencies that are accepted as
payment in your store, and customize the currency
symbols that appear in product prices and sales
documents.
Attributes
Manage attributes that are used for customer and product
information, returns, and product ratings. You can create
new attributes, edit existing attributes, and manage
attribute sets.
Shipping
Manage the Carrier, Location, Packaging, and
Experience profiles for Magento Shipping.
Other Settings
Manage the settings for reward exchange rates, gift
wrapping, and gift registries.
Before you begin, plan your store hierarchy in advance because it is referred to throughout the
configuration. Each store can have a separate root category, which makes it possible to have an
entirely different set of main menu options for each store.
Store Hierarchy
All Stores
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.
e. (Optional) Enter a Sort Order number to determine the sequence in which this view is
listed with other views.
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.
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.
l Name
l Sort Order
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!
Follow the standard instructions to install the language pack extension from Extensions
Manager or Module Manager.
1. On the Admin sidebar, tap Stores. Then under Settings, choose All Stores.
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.
e. (Optional) Enter a Sort Order number to determine the sequence in which this view is
listed with other views.
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.
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.
After you change the language of the locale, the remaining content that you have created,
including product names and descriptions, categories, CMS pages, and blocks must be
translated separately for each store view.
Translating Products
If your store has multiple views in different languages, the same products are available in each
store view. You can use the same basic product information, such as SKU, price, and inventory
level, regardless of language. Then, translate only the product name, description fields, and
meta data as needed for each language.
Process Overview:
Step 1: Translate Product Fields
Step 2: Translate Field Labels
Step 3: Translate All Categories
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 .
a. Clear the Use Default Value checkbox to the right of the field.
Make sure to translate all text fields, including image labels and Alt text, Search Engine
Optimization fields and any Custom Options information.
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.
4. In the Manage Titles section, enter a translated label for each store view.
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.
l Name
l Description
l Page Title
l Meta Keywords
l Meta Description
a. Clear the Use Default Value checkbox to the right of the field.
c. Make sure that the Create Permanent Redirect for old URL checkbox is selected
Translating Content
If your store has multiple views in different languages, and you have set the locale for each
view to a different language, the result is a partially translated site. The next step is to create a
translated version of each page that is available from the specific store view. The Store View
column of the Manage Pages list shows each view that has a translated version of the page.
To translate a content page, you must create a new page that has the same URL Key as the
original, but is assigned to the specific store view. Then, update the page for the specific view
with the translated text. The following example shows how to create a translated version of the
“About Us” page for the Spanish store view.
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.
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.
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 caches.
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 block, the welcome message, and product information.
Adding Stores
A single installation of Magento can have multiple stores that share the same Admin. Stores
that are under the same website have the same IP address and domain, use the same security
certificate, and share a single checkout process.
The important thing to understand is that the stores use the same Magento code, and share the
same Admin. Each store can have a separate catalog, or share the same catalog. Each store can
have a separate root category, which makes it possible to have a different main menu for each
store. Stores can have different branding, presentation, and content. Before you begin, take
some time to plan your store hierarchy with future growth in mind, because it is used
throughout the configuration.
Multiple Stores
Here are some examples of how URLs can be configured for multiple stores:
yourdomain.com/store1 Each store has a different path, but shares the same domain.
yourdomain.com/store2
Process Overview:
Step 1: Choose the Store Domain
Step 2: Create the New Store
Step 3: Create a Default Store View
Step 4: Configure the Store URL
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.
1. On the Admin sidebar, tap Stores. Then under Settings, choose All Stores.
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. Enter a Code in lowercase characters to identify the store. For example: mainstore.
d. Set Root Category to the root category that defines the category structure for the main
menu of the new store. If you have already created a specific root category for the store,
select it. Otherwise, select “Default Category.” You can come back later and update the
setting.
Store Information
New Store
e. In the Sort Order field, enter a number to determine the store's position when listed with
other stores.
If you were to open your store in edit mode, you would see that it now has a default view.
1. On the menu bar, tap Stores. Then under Settings, choose Configuration.
3. In the upper-left corner, set Store View to the view that you created for the new store. When
prompted to confirm scope switching, tap OK .
a. After the Base URL field, clear the Use Website checkbox.
Base URLs
5. Expand the Secure Base URLs section, and repeat the previous step as needed to
configure the store’s secure URL.
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
1. On the Admin sidebar, tap Stores. Then under Settings, choose All Stores.
Website Information
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. Set Default Store to the store that is to be used as the default for this website.
4. Set up each store and store view that is needed for the new website.
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.
https://###.###.###.###/magento/
Important! Do not change the Admin URL from the default Base URL configuration. To change the
Admin URL or path, see: Using a Custom Admin URL.
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.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
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.
Base URLs
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.
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}}
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."
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
http://www.yourdomain.com/magento/[store-code]/index.php/url-identifier
http://www.yourdomain.com/magento/index.php/url-identifier
URL Options
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
Troubleshooting
If after following the configuration instructions, some pages continue to be served with the
unsecure URL (http://), do the following:
l On the server, edit the .htaccess file (or load balancer) so the unsecure URL is redirected to
the secure URL.
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.
http://yourdomain.com/magento/
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.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
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”.
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
5. After the changes are saved, Sign Out of the Admin. Then, log back in using the new Admin
URL and path.
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:
# <frontName><![CDATA[admin]]></frontName>
# <frontName><![CDATA[backend]]></frontName>
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.
Configuration
Configuration Tabs
General
Includes basic configuration settings for the store, URLs,
theme, currency, email addresses, store contacts, editor,
and dashboard reports.
Catalog
Determines product and inventory settings, controls
sitemap and RSS feed generation, and specifies the
email template that is used to share products with
friends.
Customers
Establishes basic customer account and login options,
newsletter settings, wish list, and the format of auto-
generated coupon codes.
Sales
Determines checkout and tax settings, payment and
shipping options, sales email and PDF print-outs, and
Google API settings.
Services
Configures Magento API settings, including SOAP and
OAuth.
Advanced
Determines default Admin settings, various system
configuration settings, advanced module controls, and
developer tools (if the store is running in developer
mode).
Magento provides a variety of options to define taxes. Tax classes are used to define “tax rules.”
Tax rules are a combination of a Product Class, a Customer Class and a Tax Zone and Rate.
Magento also supports the calculation of Value-Added Tax (VAT) for business-to-business
transactions in the European Union.
The integration includes tax configuration for your stores, overrides per country, and
performance enhancing options.
Release 2.3.1
New Features
Updated configuration options:
l New Use Vertex Tax Links configuration option. Required to enable and configure
Vertex. This option increases integration performance.
l Integration URLs automatically update to use new service links. The Vertex Calculation
API URL connects to CalculateTax70, and Vertex Address Validation API URL links to
LookupTaxAreas70.
l Renamed Shipping Product Codes to Vertex Shipping Product Codes. These features
display products for each shipping type enabled. Map your shipping types to Vertex in
this section.
l New Delivery Terms options for configuring global and overrides per country for
shipping terms. These options provide support to EU VAT.
l New Vertex Logging configuration options for rotating logs. Set the frequency, actions,
and exact timing for the rotation. Logs export to a .csv file.
Automatic API disabling: If you update your product prices in the Magento catalog to
include tax, this can significantly degrade Magento performance. Vertex will automatically
disable if Display prices in Catalog is set to Including Tax. You must set this value to
Excluding Tax to re-enable Vertex.
New Cache Option: When clearing caches using Cache Management, Vertex has a cache
option included. This option improves performance during the checkout process.
Generate Returns
Vertex Cloud automatically regenerates signature-ready
PDF returns and sends a message when the returns are
available.
Pricing
2. Choose the pricing plan you want, and tap Request Info.
3. You will receive an email with a link to register your Vertex Cloud account. Click the link, and
complete the registration as follows:
Your username and password are case sensitive. Make sure to write them down for future
reference.
l Standard
l Professional
l Premium
Then, mark the checkbox of any optional features and services that you want to add to your
account.
Your company’s billing address is required if paying by credit card, and must be located in either
the U.S. or Canada.
b. Choose the Payment Method that you want to use. Then, complete the required
information.
Some of our instructions include links for more information in the Vertex Cloud Help Center. You
must be logged in to your account to gain access to the Vertex Cloud Help Center.
See the instructions in the online user guide to complete both the Vertex Cloud and Magento
configuration.
Admin permissions can be set to restrict access to tax resources, based on the business “need to
know.” To create an Admin role with access to tax settings, choose both the Sales/Tax and
System/Tax resources. If setting up a website for a region that differs from your default
shipping point of origin, you must also allow access to the System/Shipping resources for the
role. The shipping settings determine the store tax rate that is used for catalog prices.
2. For a multisite configuration, set Store View to the website and store that is the target of the
configuration.
3. Complete the following configuration settings. If necessary, clear the Use System value
checkbox of any settings that are grayed out.
Tax Classes
Tax Classes
a. Set Tax Class for Shipping to the appropriate class. The default classes are:
l None
l Taxable Goods
b. Set Tax Class for Gift Options to the appropriate class. The default classes are:
l None
l Taxable Goods
c. Set Default Tax Class for Product to the appropriate class. The default classes are:
l None
l Taxable Goods
d. Set Default Tax Class for Customer to the appropriate class. The default class is:
l Retail Customer
l Wholesale Customer
Calculation Settings
Calculation Settings
a. Set Tax Calculation Method Based On to one of the following:
Row Total The total of the line item in the order, less discounts.
Shipping Origin The address that is specified as the point of origin for your
store.
l Excluding Tax
l Including Tax
l Excluding Tax
l Including Tax
e. Set Apply Customer Tax to one of the following to determine whether tax is applied
to the original or discounted price.
l After Discount
l Before Discount
l Excluding Tax
l Including Tax
Yes Use consistent pricing across different tax rates. If the catalog price
includes tax, choose this setting to fix the price regarless of the customer’s
tax rate.
Important! If cross-border trade is enabled, the profit margin changes by tax rate. Profit is
determined by the formula (Revenue - CustomerVAT - CostOfGoodsSold). To enable
cross-border trade, prices must be set to include tax.
2. Expand the Default Tax Destination Calculation section. Then, specify the country
that is to be the default for tax calculations.
Important! Some combinations of settings related to a price display that both includes and
excludes tax can be confusing to the customer. To avoid triggering a warning message, see the
recommended settings.
Excluding Tax Catalog prices that appear in the storefront do not include tax.
Including Tax Catalog prices in the storefront include tax only if a tax rule
matches the tax origin, or if the customer’s address matches
the tax rule. This might happen after a customer creates an
account, logs in, or uses the Estimate Tax and Shipping tool
in the cart.
Including and Catalog prices that appear in the storefront are displayed both
Excluding Tax with, and without tax.
l Excluding Tax
l Including Tax
For each of the following settings, choose how you want taxes and prices to appear in the
cart, according to the requirements of your store and locale.
l Excluding Tax
l Including Tax
l Excluding Tax
l Including Tax
l Excluding Tax
l Including Tax
3. Expand the Orders, Invoices, Credit Memos Display Settings section. Then, do the
following to specify how prices and taxes appear in orders, invoices, and credit memos.
l Excluding Tax
l Including Tax
l Excluding Tax
l Including Tax
l Excluding Tax
l Including Tax
Merchants operating across regions and geographies can show their customers a single price by
including the tax in the price of the product. Pricing is clean and uncluttered regardless of tax
structures and rates that vary from country to country.
Important! When cross-border trade is enabled, your profit margin changes by tax rate. Profit is
determined by the formula: (Revenue - CustomerVAT - CostOfGoodsSold).
2. For a multisite configuration, set Store View to the website and store that is the target of the
configuration.
Calculation Settings
b. To enable cross-border price consistency, set Enable Cross Border Trade to “Yes.”
Tax Rules
Tax rules incorporate a combination of product class, customer class and tax rate. Each
customer is assigned to a customer class, and each product is assigned a product class.
Magento analyzes the shopping cart of each customer and calculates the appropriate tax
according to the customer and product classes, and the region (based on the customer’s
shipping address, billing address or shipping origin).
When numerous taxes must be defined, you can simplify the process by importing them.
Tax Rules
1. On the Admin sidebar, tap Stores. Then under Taxes, choose Tax Rules.
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.
2. Complete the form as needed. For more information, see: Tax Zones and Rates.
a. Tap Choose File, and navigate to the CSV file with the tax rates to be imported.
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 .
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.
Additional Settings
Tax Classes
Tax classes can be assigned to customers, products, and shipping. Magento analyzes the
shopping cart of each customer and calculates the appropriate tax according to the class of the
customer, the class of the products in the cart, and the region (as determined by the customer’s
shipping address, billing address or shipping origin). New tax classes can be created when a
tax rule is defined.
Customer
You can create as many customer tax classes as you
need, and assign them to customer groups. For example,
in some jurisdictions, wholesale transactions are not
taxed, but retail transactions are. You can associate
members of the Wholesale Customer group with the
Wholesale tax class.
Product
Product classes are used in calculations to determine the
correct tax rate is applied in the shopping cart. When you
create product, it is assigned to a specific tax class. For
example, food might not be taxed, or be taxed at a
different rate.
Shipping
If your store charges an additional tax on shipping, you
should designate a specific product tax class for
shipping. Then in the configuration, specify it as the tax
class that is used for shipping.
Tax Classes
3. Expand the Tax Classes section. Then, choose the tax class for each of the following:
2. Tap Add New Tax Rule. Then, expand the Additional Settings section.
b. Enter the Name of the new tax class in the text box. Then, click the checkmark to add the
new class to the list of available customer tax classes.
b. Enter the Name of the new tax class in the text box. Then, click the checkmark to add the
new class to the list of available product tax classes.
5. When complete, tap Back in the button bar to return to the Tax Rules grid.
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.
Merchants must report all digital goods sold by EU member countries on a quarterly basis to a
central tax administration, along with payment due for tax collected during the period.
Merchants who have not yet reached the threshold (50k/100k Euro of annual business) must
continue to report physical goods sold to the EU states where they have registered VAT
numbers.
Merchants who are audited for taxes paid for digital goods, must provide two pieces of
supporting information to establish the customer place of residence.
l The customer’s shipping address and a record of a successful payment transaction can be
used to establish the customer place of residence. (Payment is accepted only if the shipping
address matches payment provider information.)
l The information can also be captured directly from the data store in the Magento database
tables.
3. Assign all your digital goods to the digital goods product tax class.
4. Create tax rules 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 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
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.
Including FPT FPT is added to the base price of an item; but is not
included in tax- rule-based calculations.
Taxed Excluding FPT FPT appears as a separate row in the cart, and the
value is used in appropriate tax calculations.
Configuring FPT
The Fixed Product Tax input type creates a section of fields for managing tax for each region.
The following instructions show how to set up a fixed product tax for your store, using “eco
tax” as an example. After setting the scope for the tax and the countries and states where the
tax applies, and depending on the options you choose, the input fields can change according to
the local requirements. To learn more, see: Creating Attributes.
Process Overview:
Step 1: Enable Fixed Product Tax
Step 2: Create an FPT Attribute
Step 3: Add the FPT Attribute to an Attribute Set
Step 4: Apply FPT to Products
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
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 Sales Modules
l Emails
OPTIONS
Including FPT Only
Including FPT and FPT description
Excluding FPT. Including FPT description and final price
Excluding FPT
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:
Attribute Properties
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 grid, set Add to Column Options to
“Yes.”
c. If you want to be able to filter products in the grid based on the value of the FPT field, set
Use in Filter Options to “Yes.”
4. (Optional) In the panel on the left, choose Manage Labels. Then, enter a label to use instead of
the default label for each store view.
Manage Labels
5. When complete, tap Save Attribute. Then when prompted, refresh the cache.
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.
5. Repeat this step for each attribute set that needs to include fixed product tax.
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:
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].”
b. Set Country/State to the region where the fixed product tax applies.
c. Enter the fixed product tax as a decimal amount in the Tax field.
d. To add more fixed product taxes, tap Add Tax, and repeat the process.
If the product price includes tax, the tax appears only if there is a tax rule that matches the tax
origin, or if a customer address matches the tax rule. Events that can trigger a match include
when a customer creates an account, logs in, or generates a tax and shipping estimate from the
shopping cart.
Important! Showing prices that include and exclude tax can be confusing to the customer. To avoid
triggering a warning message, see the guidelines for your country, and recommended settings. to
avoid warning messages.
l Excluding Tax
l Including Tax
l Excluding Tax
l Including Tax
l Excluding Tax
l Including Tax
l Excluding Tax
l Including Tax
l Excluding Tax
l Including Tax
l Excluding Tax
l Including Tax
l Excluding Tax
l Including Tax
l Excluding Tax
l Including Tax
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.
1. On the Admin sidebar, tap Stores. Under Taxes, choose Tax Zones and Rates.
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. Then in the Range From and Range To fields,
enter the first and last ZIP or postal code to define the range.
ZIP/Post is Range
d. Enter the Rate Percent that is used for the tax rate calculation.
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 filter controls to find the rate you need.
Process Overview:
Step 1: Export the Magento Tax Rate Data
Step 2: Prepare the Import Data
Step 3: Import the Tax Rates
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
4. Open the new tax rate data in a second instance of the spreadsheet, so you can see both, side
by side.
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 tax zones and rates, you must first define them from the
Admin of your store, and update the tax rules as needed. Then, export the data, and open the
file in OpenOffice Calc, so it can be used for reference. However, to keep this example simple,
we will import only the standard tax rate columns.
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.
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 .
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 page controls to view the new 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 can be set up to charge a value-added tax if both the merchant and customer are
located in the same EU country. No VAT is charged if the merchant and customer are located
in different EU countries.
However, for the sale of downloadable products — or digital goods —, the VAT rate is based on
the shipping destination, rather than the merchant location. To learn more, see: EU Place of
Supply for Digital Goods.
Magento uses the following fields and configuration settings to address different scenarios.
MERCHANT INFORMATION
Stores > Configuration > General > General > Store Information
CUSTOMER INFORMATION
Create New Account Show VAT Number Determines if the customer VAT Number
Options on Storefront field is included in the Address Book that is
available in the customer account.
Default Value for VAT ID is an internal identifier for the VAT
Disable Automatic Number of the customer when used in VAT
Group Changes Validation. During VAT Validation,
Based on VAT ID Magento confirms that the number
matches the European Commission
database. Customers can be automatically
assigned to one of the four default
customer groups based on the validation
results.
Configuring VAT
The following instructions include a sample procedure to set up a 20% VAT in the U.K. for
sales to retail customers. For other tax rates and countries, follow the general procedure but
enter specific information that corresponds to your country, VAT rate, customer types, and so
on.
Before proceeding, make sure to find out which rules and regulations apply to VAT in your area.
Process Overview:
Step 1: Set Up Customer Tax Classes
Step 2: Set Up Product Tax Classes
Step 3: Set Up Tax Zones and Rates
Step 4: Set Up Tax Rules
Step 5: Apply Tax Classes to Products
1. On the Admin sidebar, tap Stores. Then, choose, 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.
1. On the Admin menu, select Sales > Tax > Product Tax Classes.
2. Click the Add New button and create three new classes:
l VAT Standard
l VAT Reduced
l VAT Zero
3. Click the Save Class button for each new class that you add.
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:
1. On the Admin menu, select Sales > Tax > Manage Tax Rules.
3. On the General page, find the Tax Class field. Then, select the VAT Class that applies to the
product.
VAT ID Validation
VAT ID Validation automatically calculates the required tax for B2B transactions that take
place within the European Union (EU), based on the merchant and customer locale. Magento
performs VAT ID validation using the web services of the European Commission server.
VAT-related tax rules do not influence other tax rules, and do not prevent the application of other tax
rules. Only one tax rule can be applied at a given time.
l VAT is charged if the merchant and customer are located in the same EU country.
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.
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.
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.
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.
TAX RULE #1
Customer Tax Class Customer tax classes must include:
A class for domestic customers
A class for customers with invalid VAT ID
A class for customers, for whom VAT ID validation failed
Product Tax Class Product tax classes must include a class for products of all types,
except bundle and virtual.
Tax Rate The tax rate must include the VAT rate of the merchant’s country.
TAX RULE #2
Customer Tax Class A class for intra-union customers.
Product Tax Class A class for products of all types, except virtual.
Tax Rate VAT rates for all EU countries, except merchant’s country. Currently
this rate is 0%.
Tax 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
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.
l Tax Rates
Create the tax rules that you need to use VAT ID Validation effectively.
In the following screenshot, the general customer settings that are not related to VAT
Validation are grayed out.
5. Set Enable Automatic Assignment to Customer Group to “Yes.” Then complete the following
fields as needed.
l Default Group
Store Information
b. Enter your VAT Number. Then, tap Validate VAT Number. The result appears immediately.
1. Continuing in the General configuration section, expand the Countries Options section.
2. In the list of European Union Countries, verify that each member country of the EU is
selected.
To change the default setting, clear the Use system values checkbox. Then, hold down the Ctrl
key, and click each country that you want to add, or remove.
Countries Options
Row Total Magento calculates the tax for each line. To calculate the tax total,
Magento rounds the tax for each line item and then adds them
together.
Total Magento calculates the tax for each item and adds those tax values
to calculate the total unrounded tax amount for the order. Magento
then applies the specified rounding mode to the total tax to determine
the total tax for the order.
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.
Including Tax Can be tax inclusive, or tax Shipping is treated as another item in
can be displayed cart with taxes, using the same
separately. calculations.
Tax shipping? No
Comment All tax zones are the same priority; ideally, a zone for state and one or
more zones for zip code lookup.
Tax Classes
TAX CLASS RECOMMENDED SETTING
Tax Class for Shipping None
Calculation Settings
CALCULATION RECOMMENDED SETTING
Tax Calculation Method Based On Total
Default Post Code The postal code that is used in your tax zones.
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 4: Create a GST Tax Rule
Step 5: Create a PST Tax Rule for Saskatchewan
Step 6: Save and Test the Results
1. On the Admin menu, select System > Configuration. Then in the panel on the left, under
Sales, select Tax.
Tax Classes
FIELD RECOMMENDED SETTING
Tax Class for Shipping Shipping (shipping is taxed)
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.
Country Canada
State * (asterisk)
Zip/Post is Range No
Country Canada
State Saskatchewan
Zip/Post is Range No
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.
Priority 0
Sort Order 0
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.
Priority 1
Sort Order 0
2. Return to your storefront, and create a sample order to test the results.
EU Tax Guidelines
The following example depicts a store based in France that sells > 100k Euros in France and >
100k Euros in Germany.
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 It might be necessary to edit the catalog to ensure that it shows up in the correct
category/website/store view.
Process Overview:
Step 1: Create Three Product Tax Classes
Step 2: Create Tax Rates for France and Germany
Step 3: Set Up the Tax Rules
Step 4: Set Up a Store View for Germany
Step 5: Configure Tax Settings for France
Step 6: Configure Tax Settings for Germany
For this example, it is assumed that multiple VAT-Reduced product tax classes are not needed.
Tax Rates
TAX RATE SETTING
France-StandardVAT Country: France
State/Region: *
ZIP/Postal Code: *
Rate: 20%
State/Region: *
ZIP/Postal Code: *
Rate: 5%
State/Region: *
ZIP/Postal Code: *
Rate: 19%
State/Region: *
ZIP/Postal Code: *
Rate: 7%
Tax Rules
TAX RULE SETTING
Retail-France-StandardVAT Customer Class: Retail Customer
Priority: 0
Sort Order: 0
Priority: 0
Sort Order: 0
Priority: 0
Sort Order: 0
Priority: 0
Sort Order: 0
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.
c. On the General page, expand the Countries Options section, and set the default
country to “France.”
3. In the upper-left corner, choose the German Store View. Then, do the following:
a. On the General page, expand Countries Options, and set the default country to
“Germany.”
General Settings
FIELD RECOMMENDED SETTING
TAX CLASSES
CALCULATION SETTINGS
Default State
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.
b. Update the following values to match your site's Shipping Settings point of origin.
l Default Country
l Default State
This setting ensures that tax is calculated correctly when product prices include tax.
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:
Excluding tax OK OK OK
Including tax OK OK OK
Including tax OK OK OK
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 RECOMMENDED SETTING
Apply Customer Tax After Discount
EU Including Tax
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
Currency Configuration
Before setting up individual currency rates, you must first set the scope of the base currency,
By default, it is set to global, which applies the base currency setting to the entire store
hierarchy. If you have a multisite installation of Magento, you can manage multiple base
currencies by setting the scope to the website level.
Then, specify which currencies you accept, and the currency that you want to use for the
display of prices in your store. In the following illustration, the scope of the base currency is set
at the website level, so each website can have a different base currency.
Process Overview:
Step 1: Choose the Accepted Currencies
Step 2: Configure the Import Connection
Step 3: Configure the Scheduled Import Settings
Step 4: Update the Currency Rates
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2. In the upper-right corner, set Store View to the store view where the configuration applies.
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 the store
view.
c. In the Allowed Currencies list, select all currencies that you accept as payment in the
store view. Make sure to also select your primary currency. (For multiple currencies, hold
down the Ctrl key and select each option.)
Currency Options
5. When prompted to refresh the cache, tap the Close ( )box in the upper-right corner of the
system message. We’ll refresh the cache later.
a. In the panel on the left under Catalog, choose Catalog. Then, scroll down and expand
the Price section.
Price
1. Scroll back up to the top of the page. In the panel on the left under General, choose Currency
Setup.
3. In the Connection Timeout in Seconds field, enter the number of seconds of inactivity to
allow before the connection times out.
WebserviceX
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:
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 store contact that appears as the sender of the error
notification.
f. Set Error Email Template to the email template used for the error notification.
4. When prompted to update the cache, tap the Cache Management link. Then, refresh the
invalid cache.
Refresh Cache
Currency Symbols
Manage Currency Symbols gives you the ability to customize the symbol associated with each
currency that is accepted as payment in your store.
Currency Symbols
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.
5. When prompted to update the cache, tap the Cache Management link. Then, refresh any
invalid cache.
Refresh Cache
Before importing currency rates, complete the Currency Rate Setup to specify the currencies
that you accept, and to establish the import connection and schedule.
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.
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.
5. When prompted to update the cache, tap the Cache Management link. Then, refresh all
invalid caches.
2. Complete the Currency Rate Setup 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.
l Product Attributes
l Attribute Sets
l Data Transfer
Customer Attributes
Customer attributes provide the information that is required to support the order, fulfillment,
and customer management processes. Because your business is unique, you might need fields
in addition to those provided by the system. You can add custom attributes to the Account
Information, Address Book, and Billing Information sections of the customer’s account.
Customer address attributes can also be used in the Billing Information section during
checkout, or when guests register for an account.
Customer Attributes
1. On the Admin sidebar, tap Stores. Then under Attributes, choose Customer.
The attribute code must begin with a letter, and can include any combination of lowercase
letters (a-z) and numbers (0-9). The code must be less than thirty characters in length,
and cannot include special characters or spaces. The underscore character (_) can be used
to indicate a space.
Shortcut: To complete only the required fields at this time, scroll down to Storefront
Properties, enter the Sort Order, and save.
a. To determine the type of input control that is used for data entry, set Input Type to one of
the following:
l Text Field
l Text Area
l Multiple Line
l Date
l Dropdown
l Multiple Select
l Yes/No
l File (attachment)
l Image File
b. If the customer must enter a value in the field, set Values Required to “Yes.”
d. To check the data entered into the field for accuracy before the record is saved, set Input
Validation to the type of data to be allowed in the field. The available values depend on
the Input Type specified.
Alpha Only Accepts only alphabetic characters (a-z, A-Z) during data
entry.
Length Only Validates the input based on the length of the data entered
into the field.
e. To limit the size of Text Field and Text Area input types, enter the Minimum Text Length
and Maximum Text Length.
f. To apply a preprocessing filter to values entered in a text field, text area, or multiple line
input type, set Input/Output Filter to one of the following:
None Does not apply a filter to text entered into the field.
Strip HTML Tags Removes HTML tags from the text. This filter can help clean
up data that is pasted into a field from another source that
includes HTML tags.
a. To be able to include the column in the Customers grid, set Add to Column Options to
“Yes.”
b. To filter the Customers grid by this attribute, set Use in Filter Options to “Yes.”
c. To search the Customers grid by this attribute, set Use in Search Options to “Yes.”
d. To make this attribute available to customer segments, set Use in Customer Segment to
“Yes.”
2. Enter a number in the Sort Order field to determine its order of appearance when listed with
other attributes.
3. Set Forms to Use to each form that is to include the attribute. To choose multiple options,
hold the Ctrl key down and click each form.
l Customer Registration
l Admin Checkout
Storefront Properties
2. Under Manage Titles, enter a label to identify the attribute for each store view.
Manage Labels/Options
Field Descriptions
FIELD DESCRIPTION
ATTRIBUTE PROPERTIES
Default Label The default label that identifies the attribute in the Admin and
storefront.
Attribute Code A unique code that identifies the attribute within the system. The
code can be up to 21 characters in length, and cannot include
spaces or special characters. The underscore symbol can be used
instead of a space.
Input Type Determines the input control that is used for data entry. Options:
Related properties:
Values Required Determines if a value must be entered into the field. Options: Yes/No
Input Validation The selection of options is determined by the input type. Options:
Minimum Text Length Determines the minimum number of characters or numbers that can
be entered into the field.
Maximum Text Length Determines the maximum number of characters or numbers that can
be entered into the field.
Input/Output Filter Applies a preprocessing filter to values entered in a text field, text
area, or multiple line input type before the record is saved. Options:
None
Strip HTML Tags (Text Input Type)
Escape HTML Entities (Text Input Type)
Normalize Date (Date Input Type)
Add to Column Options Specifies if the attribute is included as a column in the Customers
grid. Options: Yes/No
Use in Filter Options Specifies if the attribute can be used as a filter for search operations
from the grid. Options: Yes/No
Use in Search Options Specifies if the attribute value can be used as a keyword in search
operations. Options: Yes/No
STOREFRONT PROPERTIES
Sort Order Specifies the sort order of this attribute in relation to other customer
attributes. The sort order determines the sequence that fields receive
focus during data entry when using keyboard navigation.
website_id The website ID of the site where the customer account was created.
prefix Any prefix that is used with the customer name.(Mr., Ms., Mrs., Dr.,
etc.)
suffix Any suffix that is used with the customer name. (Jr., Sr., Esquire,
etc.)
taxvat The Value Added Tax (VAT) ID that is assigned to the customer. The
default label of this attribute is “VAT Number.”. The VAT number field
is always present in all shipping and billing customer addresses when
viewed from the Admin, but is not a required field.
Custom address attributes can be set up if you need to provide additional information such as
an optional email address, Skype account, alternate phone number, building, or county. The
custom attribute can then be incorporated into the address template that is used to produce
sales documents. The process to create a custom address attribute is almost the same as
creating a customer attribute.
1. On the Admin sidebar, tap Stores. Then under Attributes, choose Customer Address.
The attribute code must begin with a letter, and can include any combination of lowercase
letters (a-z) and numbers (0-9). The code must be less than thirty characters in length,
and cannot include special characters or spaces. The underscore character (_) can be used
to indicate a space.
Shortcut: To complete only the required fields at this time, scroll down to Storefront
Properties, enter the Sort Order, and save.
a. To determine the type of input control that is used for data entry, set Input Type to one of
the following:
l Text Field
l Text Area
l Multiple Line
l Date
l Dropdown
l Multiple Select
l Yes/No
l File (attachment)
l Image File
b. If the customer must enter a value in the field, set Values Required to “Yes.”
d. To check the data entered into the field for accuracy before the record is saved, set Input
Validation to the type of data to be allowed in the field. The available values depend on
the Input Type specified.
Alpha Only Accepts only alphabetic characters (a-z, A-Z) during data
entry.
Length Only Validates the input based on the length of the data entered
into the field.
e. To apply a preprocessing filter to values entered in a text field, text area, or multiple line
input type, set Input/Output Filter to one of the following:
None Does not apply a filter to text entered into the field.
Strip HTML Tags Removes HTML tags from the text. This filter can help clean
up data that is pasted into a field from another source that
includes HTML tags.
a. To be able to include the column in the Customers grid, set Add to Column Options to
“Yes.”
b. To filter the Customers grid by this attribute, set Use in Filter Options to “Yes.”
c. To search the Customers grid by this attribute, set Use in Search Options to “Yes.”
d. To make this attribute available to customer segments, set Use in Customer Segment to
“Yes.”
2. Enter a number in the Sort Order field to determine its order of appearance when listed with
other attributes.
3. Set Forms to Use to each form that is to include the attribute. To choose multiple options,
hold the Ctrl key down and click each form.
Storefront Properties
2. Under Manage Titles, enter a label to identify the attribute for each store view.
Manage Labels/Options
Field Descriptions
FIELD DESCRIPTION
ATTRIBUTE PROPERTIES
Default Label The default label that identifies the attribute in the Admin and
storefront.
Input Type Determines the input control that is used for data entry. Options:
Related properties:
Values Required Determines if a value must be entered into the field. Options: Yes/No
Input Validation The selection of options is determined by the input type. Options:
Add to Column Options Specifies if the attribute is included as a column in the Customers
grid. Options: Yes/No
Use in Filter Options Specifies if the attribute can be used as a filter for search operations
from the grid. Options: Yes/No
Use in Search Options Specifies if the attribute value can be used as a keyword in search
operations. Options: Yes/No
STOREFRONT PROPERTIES
Forms to Use in Determines the pages with data entry forms where the attribute
appears. Hold down the Ctrl key to choose multiple forms. Options:
Customer Address Registration
Customer Account Address
{{var country}}<br/>
Address Templates
3. Click to expand the Address Templates section. The section includes a separate set of
formatting instructions for each of the following:
l Text
l HTML
l PDF
Product Attributes
Product attribute properties determine how an attribute can be used in the catalog, its
appearance and behavior in the store, and in data transfer operations. The properties and labels
associated with each attribute determine how it can be used, and its presentation in the store.
Properties The Properties section includes both basic and advanced attribute
properties.
Labels The label identifies an attribute in the Admin and also in the storefront
of each store view. If your store is available in multiple languages, you
can enter a different translated label for each language.
Storefront The Storefront Properties determine how an attribute can be used in your
Properties 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.
Property Descriptions
PROPERTY DESCRIPTION
ATTRIBUTE PROPERTIES
Default Label The label that identifies the attribute during data entry.
Catalog Input Type for Determines the data type and input control that is used to manage the
Store Owner product from the store Admin. Options include:
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
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.
Default Value Assigns a starting value to the attribute to help during data entry. To
assign a default value for Multiple Select or Dropdown input types,
see: Creating Product Attributes.
Unique Value Requires the attribute value to be different from all other values
entered in the same attribute, within the context of the scope setting.
Unique value should be enabled for any attribute that is used as an ID
number. For example, because SKU is used to identify products
throughout the hierarchy, it has a unique value with a global scope.
Options: Yes / No
Add to Column Options Determines if the column appears in the product grid. Options: Yes /
No
Use in Filter Options Determines if the attribute is used as a filter control at the top of
columns in the grid. Options: Yes / No
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:
Use In Search Results To include the attribute in the layered navigation for search results,
Layered Navigation select “Yes.” Options include: Yes / No
The Position field will be grayed out by default. You must save the
attribute before you can modify this setting.
Use for Promo Rule To make the attribute available for use in price rules, select “Yes.”
Conditions Options include: Yes / No
Allow HTML Tags on (Text Field and Text Area input types only) To be able to format the
Storefront attribute value with HTML tags, select “Yes.” Options include: Yes /
No
Visible on Catalog Pages (Simple and virtual products only) To include the attribute on the
on Storefront Additional Information tab of the product page, select “Yes.” Options
include: Yes / No
Used in Product Listing Depends on the theme. To include the attribute in product summaries
that appear in catalog listings, select “Yes.”
2231
Contents Security Best Practices
Security Action Plan
In this section of the guide, you’ll learn how to Configuring Admin Security
import and export data, manage security and CAPTCHA
permissions, install extensions and integrations,
Two-Factor Authentication
and use the many tools that are available to
Using Two-Factor Authentication
maintain your store at peak performance.
Managing Two-Factor Authentication
System Menu Encryption Key
Data Transfer Session Validation
Browser Capabilities Detection
Working with CSV Files Action Log
Data Validation Report
Import Archive
Import History Bulk Actions
Product Images
Importing Tier Prices Tools
Import Guidelines Cache Management
Export Full Page Cache
Export Criteria Index Management
Scheduled Import/Export IndexTrigger Events
Scheduling an Import Backups
Scheduling an Export Cron (Scheduled Tasks)
Product Attribute Reference Developer Tools
Complex Data Frontend Development Workflow
Advanced Pricing Using Static File Signatures
Customer Attribute Reference Optimizing Resource Files
Developer Client Restrictions
Integrations Template Path Hints
Magento Marketplace Translate Inline
Permissions Web Setup Wizard
Adding Users Extension Manager
Locked Users Module Manager
User Roles System Upgrade
Role Resources System Configuration
Support
Alternate Media Storage Data Collector
Using a Database System Report
Using a CDN
Security
Security Scan
2232
CHAPTER 116:
System Menu
The System Menu includes tools to import and export data, install extensions, manage system
caches and indexes, manage permissions, backups, system notifications, and custom variables.
System Menu
Menu Options
Data Transfer
The Import and Export tools give you the ability to
manage multiple records in a single operation. You
can import new items, and also update, replace, and
delete existing products and tax rates.
Extensions
Manage integrations and extensions for your store.
Tools
Manage your system resources, including cache and
index management, backups, and installation
settings.
Support
The Support Tools can be used as a resource during
the development and optimization processes, and as
a diagnostic tool to help our Support team identify
and resolve issues with your system.
Permissions
Magento uses roles and permissions to create different
levels of access for Admin users, which gives you the
ability to grant permission on a “need to know” basis
to people who work on your site.
Action Log
The Action Log tracks the activities of administrators
who work in your store. For most events, the available
information includes the action, the name of the user
who performed it, whether it was a success or failure,
and the ID of the object that was the target of the
action. The Admin Actions archive lists the CSV log
files that are stored on the server.
Other Settings
Manage the notifications in your inbox, create custom
variables, and generate a new encryption key.
Amazon Logs
Provides access to Client and IPN logs, if enabled in
the Developer Options section of the Amazon Pay
configuration.
l Import
l Export
l Scheduled Import/Export
Export CSV
Important! We recommend that you use a program that supports UTF-8 encoding, such as
Notepad++ or OpenOffice Calc, to edit CSV files. Microsoft Excel inserts additional characters into
the column header of the CSV file, which can prevent the data from being imported back into
Magento. If you work on the Mac, you can save your data in the CSV (Windows) format.
CSV files have a specific structure that must match the database. Each column heading
corresponds to the Attribute Code of the field that is represented by the column. To ensure that
the column headings can be read by Magento, first export the data from your store as a CSV
file. You can then edit the data and re-import it into Magento.
If you open an exported CSV file in a text editor, you will see that values are separated by
commas, and multiple values are enclosed in double-quotes. During import, you can specify a
custom separator character, although a comma is the default.
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:
To import data, you need to include only the SKU and any columns with changes. Any blank
columns are ignored during the import process. It is not possible to add attributes during the
import process. You can include only existing attributes.
For a detailed description of each product attribute, see: Product Attribute Reference.
<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.
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.
<attribute name> The names of the columns with values of both system-created
attributes, and attributes created by the store administrator.
Data Validation
All data must pass validation before it can be imported into the store, to ensure that the values
are consistent with the system database. Validation begins when you tap the Check Data
button. During the process, all entities in the import file are verified for the following:
Attributes Column header names are verified to ensure that they match the
corresponding attributes in the system database. The value of
each attribute is checked to ensure that it meets the requirements
of the data type (decimal, integer, varchar, text, and datetime)
Complex Data Values that originate from a defined set, such as a drop-down or
multiple select input type, are verified to ensure that the values
exist in the defined set.
Service Data The values in service data columns are verified to ensure that the
properties or complex data values are consistent with what is
already defined in the system database.
Required Values For new entities, the presence of required attribute values in the
file is checked. For existing entities, there is no need to re-check
the existence of required attribute values.
The results of the validation appear in the Validation Results section, and include the following
information:
File is Valid!
If validation fails, read the description of each error, and correct the problem in the CSV file.
For example, if a row contains an invalid SKU, the import process stops, and that row, and all
subsequent rows are not imported. After correctly the problem, import the data again. If many
errors are encountered, it might take several attempts to pass validation.
DATA VALIDATION
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 Column name %column name% is invalid. Should start with a letter. Alphanumeric.
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.
Import
Data for all product types can be imported into the store. In addition, you can import
products, advanced pricing data, customer data, customer address data, and product images.
Import supports the following operations:
l Add/Update
l Replace
l Delete
The size of the import file is determined by the settings in the php.ini file on the server. The
system message on the Import page indicates the current size limit. The default size is 2MB.
Special characters — such as the equal sign, greater and less than symbols, single and double
quotes, backslash, pipe, and ampersand symbols — can cause problems during data transfer.
To ensure that such special characters are correctly interpreted, they can be marked as an
“escape sequence.” For example, if the data includes a string of text such as
code=”str”,code=”str2”, choosing to enclose the text in double quotes ensures that the original
double quotes are understood to be part of the data. When the system encounters a double set
of double quotes, it understands that the outer set of double quotes is enclosing the actual
data.
When importing product data, new product data is added to existing product data entries in
the database. All fields except SKU can be updated through import. All existing product data is
replaced with the imported new data. Exercise caution when replacing data. All existing
product data will be completely cleared and all references in the system will be lost.
Import
Process Overview:
Step 1: Prepare the Data
Step 2: Choose the Import Behavior
1. On the Admin sidebar, tap System. Then under Data Transfer, choose Import.
l Advanced Pricing
l Products
l Customer Addresses
3. Tap Download Sample File. Then on the download menu in the lower-left corner of your
browser window, choose Open.
The sample file includes column headings with placeholder data for example product types.
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.
l Add/Update
For products, you can update all fields except SKU through import.
l Replace
l Delete
2. To determine what happens when an error is encountered when importing data, choose one of
the following:
l Stop on Error
Then in the Allowed Errors Count field, enter the number of errors that can occur before the
import is canceled. The default value is 10.
3. Do the following:
a. Accept the default value of a comma (,) for the Field separator.
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.
c. If you want to enclose any special characters that might be found in the data as an
“escape sequence,” mark the Fields Enclosure checkbox.
Import Behavior
2. Find the CSV file that you prepared to import, and tap Open .
3. In the Images File Directory field, enter the relative path to the location on the Magento server
where uploaded images are stored. For example: var/import.
To learn more about importing product images, see: Importing Product Images.
File to Import
2. Then, wait a few moments for the validation process to complete. If the import data is valid,
the following message appears:
File is Valid!
3. If the file is valid, tap Import . Otherwise, correct each problem with the data that is listed in
the message, and try to import the file again.
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.
Import Behavior
OPERATION DESCRIPTION
Add/Update 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
For products, you can update all fields except SKU through import.
If a SKU in the import data matches the SKU of an existing entity, all
fields, including the SKU are deleted, and a new record is created
using the CSV data. An error occurs if the CSV file references a SKU
that does not exist in the database. You can Check Data to display
error.
Delete Any entities in the import data that already exist in the database are
deleted from the database.
Delete ignores all columns in the import data, except for SKU. You
can disregard all other attributes in the data.
An error occurs if the CSV file references a SKU that does not exist
in the database. You can Check Data to display error.
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.
Import History
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.
1. On the Magento server, upload the image files to the pub/media/import folder. This is the
default folder for importing product images.
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.
After selecting the file to import, enter the relative path following Images File Directory:
/pub/media/import
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
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
If there is no value, or there is a non-valid value, for a required attribute, then the existing
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
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
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
Export
The best way to become familiar with the structure of your database is to export the data and
open it in a spreadsheet. Once you become familiar with the process, you’ll find that it is an
efficient way to manage large amounts of information.
Special characters — such as the equal sign, greater and less than symbols, single and double
quotes, backslash, pipe, and ampersand symbols — can cause problems during data transfer.
To ensure that such special characters are correctly interpreted, they can be marked as an
“escape sequence.” For example, if the data includes a string of text such as
code=”str”,code=”str2”, choosing to enclose the text in double quotes ensures that the original
double quotes are understood to be part of the data. When the system encounters a double set
of double quotes, it understands that the outer set of double quotes is enclosing the actual
data.
To export data:
1. On the Admin sidebar, tap System. Then under Data Transfer, choose Export.
l Products
l Customer Addresses
c. If you want to enclose any special characters that might be found in the data as an “escape
sequence,” mark the Fields Enclosure checkbox.
Export Settings
3. The Entity Attributes section lists all the available attributes in alphabetical order. You can use
the standard list controls to search for specific attributes, and to sort the list. The Search and
Reset Filter controls control the display of the list, but have no effect on the selection of
attributes to be included in the export file.
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.
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.
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
Export Filters
You can use filters to determine which SKUs are included in the export file. For example, if you
enter a value in the Country of Manufacture filter, the exported CSV file will incude only
products manufactured in that country.
The type of filter corresponds to the data type. For date fields, you can choose the date from the
Calendar . To learn more, see: Attribute Input Types. The format of the date is determined
by the locale.
To inlcude only records with a specific value, such as a sku, type the value into the Filter field.
Some fields such as Price, Weight, and Set Product as New have a from/to range of values.
Exclude Attributes
The checkbox in the first column is used to exclude attributes from the export file. If an
attribute is excluded, the associated column in the export data is included, but empty.
Export Criteria
EXCLUDE FILTER RESULT
No The exported file contains each attribute for all existing records.
Yes The export file contains each attribute with only the records allowed
by the filter.
No The export file does not include the column for the excluded
attribute, but does include all existing records.
Yes The export file does not include the column for the excluded
attribute, and contains only the records allowed by the filter.
l Configurable Products
l Tier Prices
In the following example, you will add a set of product variations for a new size in each color.
First, you will export the configurable product, and examine the data structure. Then, you will
update the data and import it back into the catalog. If you don’t want to go through the
exercise of exporting the data, you can download the CSV file that is used in the example.
1. Before you begin, make sure that the attributes that are used for product variations have the
required property settings.
Scope Global
Catalog Input Type for The input type of any attribute that is used for a product
Store Owner variation must be one of the following:
Dropdown
Visual Swatch
Text Swatch
Multi-Select.
2. If you are adding a new size or color, or making any other change to an existing attribute,
make sure to update the attribute with the new value.
a. On the Admin sidebar choose Stores. Then under Attributes, choose Product.
c. Add the new value to the attribute. In the following example, a new size is added to a Text
Swatch.
4. If you are adding a new attribute, follow the instructions to create the attribute before you
begin.
1. On the Admin sidebar, choose Catalog. Then, tap Products, and do the following:
a. Tap Filters. Then, set Type to “Configurable Product, and tap Apply Filters.
b. Choose the configurable product that you want to use for your test export, and take note
of the SKU.
2. On the Admin sidebar, choose System. Then under Data Transfer, choose Export.
Export Settings
a. Enter the SKU of the configurable product that you have chosen to export, and tap
Continue.
SKU
b. When the export file appears at the bottom of the window, click Open.
When opened in a spreadsheet, the CSV file has a separate row for each simple product
variation, and one row for the configurable product. The product_type column shows
multiple simple product variations that are associated with one configurable product.
c. Scroll to the far right of the worksheet to find the following columns. In this example, the
data can be found in columns CG and CH.
configurable_variations
configurable_variation_labels
Data Format
sku={{SKU_VALUE}},attribute1={{VALUE}},attribute2={{VALUE}}| sku={{SKU_
VALUE}},attribute1={{VALUE}},attribute2={{VALUE}}
Each sku is separated by a pipe symbol (|), and attributes are separated by a comma. The
value of each attribute is represented by the attribute code, rather than the attribute label.
Here’s how the actual data appears:
Example Data
sku=MH01-XS-Black,size=XS,color=Black|sku=MH01-XS-
Gray,size=XS,color=Gray|sku=MH01-XS-Orange,size=XS,color=Orange
5. When you understand the structure of configurable product data, you can edit the data, or add
new variations directly to the CSV file. To learn more, see: Complex Data.
In the following example, the set of XL sizes is copied and pasted into the worksheet to create a
new set of product variations for a new size in each color.
1. Copy the set of product variations that you want to use as a template for the new products.
2. Insert the copied rows records into the worksheet. You now have two identical sets of the
simple product variations.
3. Update the data in the following columns of the new variations, as needed. For this example,
all the “XL” references are changed to “XXL”.
l sku
l name
l url_key
l additional_attributes
4. The next step is to update the information in the product_variations column of the
configurable product record, so the new variations are included as part of the configurable
product.
a. On the row with the configurable product record, click the cell that contains the product_
variations data. Then in the formula bar, copy the last set of parameters, beginning with
the pipe symbol.
product_variations
b. Paste the parameters to the end of the data. Then, edit as needed for the new variations.
In this example, the sku and size parameters are updated for the new “XXL” size.
5. Before the data is imported back into the catalog, delete any rows that have not changed.
In this example. only the three new variations for the new size, and the row with the updated
configurable product are imported back into the catalog. The other rows can be deleted from
the CSV file. However, make sure not to delete the header row with column labels.
6. Save the CSV file.The data is ready to import into the catalog.
1. On the Admin sidebar, choose System. Then under Data Transfer, choose Import.
Import Settings
Import Behavior
4. Under File to Import, tap Choose File. Then, navigate to the CSV file that you prepared for
import and choose the file.
File to Import
6. If the file is valid, tap Import. Otherwise, correct any problems found in the data and try again.
Validation Results
7. When the import is complete, click the Cache Management link in the message at the top of
the page. Then, refresh all invalid caches.
The new product variations are now available in the catalog from the Admin and in the
storefront. In this example, the hoodie is now available in size XXL for all colors.
Tier Pricing
Tier Pricing
1. On Admin sidebar, choose System. Then under Data Transfer, choose Export.
3. In the Entity Attributes grid, scroll down to the SKU attributes. Then, do the following:
a. For tier prices that are based on a discount percentage. enter the SKU of each product to
be exported, separated by a comma.
SKU(s) to Export
a. For tier prices that are based on a fixed amount. enter the SKU of each product.
5. Look in the lower-left corner of your browser window for the export file. Then, open the file.
l sku
l tier_price_website
l tier_price_customer_group
l tier_price_qty
l tier_price
l tier_price_value_type
You will use the exported data as a template for importing tier price data.
2. Any products without tier price updates can be deleted from the CSV file. There is no need to
reimport products that haven’t changed.
1. On Admin sidebar, choose System. Then under Data Transfer, choose Import.
2. Under Import Settings, set Entity Type to “Advanced Pricing.” Then, set Import Behavior to
“Add/Update”.
3. Under File to Import, tap Choose File. Then, select the file that you prepared to import from
your directory.
5. 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.
Scheduled Import/Export
Scheduled imports and exports can be run on a daily, weekly or monthly basis. The files to be
imported or exported can be located on local Magento servers, or on remote FTP servers.
Scheduled Import/Export is implemented by default, and does not require additional
configuration. All scheduled imports and exports are managed by the Cron job scheduler.
Scheduled Import/Export
2. To create a new scheduled import or export job, tap the appropriate button. Then follow the
instructions for the type of scheduled job.
When the record is saved, the job appears in the Scheduled Import/Export grid.
3. After each scheduled job, a copy of the file is placed in the var/log/import_export directory on
the Magento local server.
The details of each operation are not written to the log. If an error occurs, notification is sent of
the failed import/export job, with a description of the error.
Scheduling an Import
The Scheduled Import process is similar to the manual Import process, with respect to the
available import file format and types of import entities:
The advantage of using Scheduled Import is that you can import a data file multiple times
automatically, after specifying the import parameters, and schedule only once.
After each import operation, a copy of the import file is placed in the var/log/import_export
directory on the server where Magento is deployed. The timestamp, the marker of the imported
entity (products or customers), and the type of the operation (in this case, import) are added to
the import file name.
After each scheduled import job, a reindex operation is performed automatically. On the
frontend, changes in the descriptions and other text information are reflected after the updated
data goes to the database, and the changes in prices are reflected only after the reindex
operation.
Process Overview
Step 1: Complete the Import Settings
Step 2: Complete the Import File Information
Step 3: Configure the Import Failed Emails
1. On the Admin sidebar, tap System. Then under Data Transfer, choose Import/Export.
2. In the upper-right corner, tap Add Scheduled Import. Then, do the following:
b. Enter a brief Description that explains the purpose of the import, and how it is to be
used.
l Products
l Customers
Append Complex Adds new complex data to the existing complex data for existing
Data entries in the database. This is the default value.
Replace Existing Writes over existing complex for existing entities in the database.
Complex Data
e. Set Start Time to the hour, minute, and second that the import is scheduled to begin.
l Daily
l Weekly
l Monthly
3. In the Field Separator field, enter the character that is used to separate fields in the import
file. The default character is a comma.
4. In the Multiple Value Separator field, enter the character that is used to separate multiple
values within a field.
Import Settings
Local Server Imports the data from the same server where Magento is installed.
l For Local Server, enter a relative path in the Magento installation. For example, var/import.
l For Remote FTP server, enter the full URL and path to the import folder on the remote
server.
4. In the Images File Directory field, enter the path to the directory where product images are
stored. On a local server, enter a relative path such as: var/import.
1. Set Failed Email Receiver to the store contact who is to receive notification if an error occurs
during the import.
2. Set Failed Email Sender to the store contact that appears as the sender of the notification.
3. Set Failed Email Template to the template that is used for the notification.
4. In the Send Failed Email Copy To field, enter the email address of anyone who is to receive a
copy of the notification. Separate multiple email addresses with a comma.
Bcc Sends a blind courtesy copy of the failed import notification. The name
and address of the recipient is included in the original email
distribution, but hidden from view.
Separate Email Sends a copy of the failed import notification as a separate email.
The new scheduled import job is added to the list on the Scheduled Import/Export page. From
this page it can be run immediately for testing and edited. The import file is validated before
the execution of each import job.
Field Descriptions
FIELD DESCRIPTION
IMPORT SETTINGS
Name The name of the import. Helps you to distinguish it if many different
scheduled imports are created.
Import Behavior Defines how complex data is handled if entities, which are being
imported, already exist in the database. Complex data for products
include categories, websites, custom options, tier prices, related
products, up-sells, cross-sells, and associated products data.
Complex data for customers include addresses.Options:
Start Time Set the start hour, minutes, and seconds of the import.
On Error Define the system behavior in case errors are found during file
validation. Options:
Stop Import The file is not imported if any errors are found
during validation. This is the default value.
Status The import is enabled by default. You can suspend it by setting the
Status to Disabled.
Field Separator Determines the character that is used to separate fields. Default
value: , (comma)
Server Type You can import from a file located on the same server where Magento
is deployed (select Local Server) or from the remote FTP server
(select Remote FTP). If you select Remote FTP, additional options
for credentials and file transfer settings appear.
File Directory Specify the directory where the import file is located. If Server Type
is set to Local Server, specify the path relative to the Magento
installation directory. For example, var/import.
Images File Directory Enter the path to the directory where product images are stored. For a
local server, enter a relative path. For example: var/import
Failed Email Receiver Specify the email address to which an email notification (failed import
email) is sent if the import fails.
Failed Email Sender Specify the email address that is used as the sender for the import
failed email.
Failed Email Template Select a template for the import failed email. By default, only the
Import Failed (Default Template from Locale option is available.
Custom templates can be created under System > Transactional
Emails.
Send Failed Email Copy The email address to which a copy of import failed email is sent.
To
Send Failed Email Copy Select the copy sending method for the import failed email.
Method
Scheduling an Export
Scheduled Export is similar to manual Export, with respect to the available export file format
and types of entities that can be exported:
The advantage of using Scheduled Export is that you can export data multiple times
automatically, after specifying the export parameters, and schedule only once
After each export, the export file is placed in the user-defined location, and a copy of the file is
placed in the var/log/import_exportdirectory on the server where Magento is deployed. The
timestamp and the marker of the exported entity (products or customers) and type of the
operation (in this case, export) are added to the export file name.
Process Overview
Step 1: Complete the Export Settings
Step 2: Complete the Export File Information
Step 3: Configure the Export Failed Emails
Step 4: Choose the Entity Attributes
1. On the Admin sidebar, tap System. Then under Data Transfer, choose Scheduled
Import/Export.
2. In the upper-right corner, tap Add Scheduled Export. Then, do the following:
b. Enter a brief Description that explains the purpose of the export, and how it is to be used.
l Products
l Customers
The Entity Attributes section at the bottom of the page is updated to reflect the selected
Entity Type.
d. Set Start Time to the hour, minute, and second that the export is scheduled to begin.
l Daily
l Weekly
l Monthly
Export Settings
Local Server To save the export file on the same server where Magento is installed.
2. Enter the File Directory where the export file is to be saved as follow:.
l For Local Server, enter a relative path within the Magento installation. For example,
var/export.
l For Remote FTP server, enter the full URL and path to the target folder on the destination
server.
1. Set Failed Email Receiver to the store contact who is to receive notification if an error occurs
during the export.
2. Set Failed Email Sender to the store contact that appears as the sender of the notification.
3. Set Failed Email Template to the template that is used for the notification.
4. In the Send Failed Email Copy To field, enter the email address of anyone who is to receive a
copy of the notification. Separate multiple email addresses with a comma.
Bcc Sends a blind courtesy copy. The name and address of the recipient is
included in the original email distribution, but is hidden from view.
1. In the Entity Attributes section, choose the attributes that you want to include in the export
data.
l To filter export data by attributes value, enter the attribute value in the Filter column.
l To exclude products or customers with certain attribute values, enter the values of the
attributes that you want to exclude, and select the checkbox in the Skip column.
The new scheduled export job is added to the list on the Scheduled Import/Export page. From
this page it can be run immediately, for testing, and edited.
Field Descriptions
FIELD DESCRIPTION
EXPORT SETTINGS
Name The name of the export. Helps you to distinguish it if many different
scheduled exports are created.
Entity Type Identifies the data to be exported. After the selection is made, the
Entity Attributes appear below. Options include: Products
/Customers.
Start Time Set the start hour, minutes, and seconds of the export.
Frequency Define how often the export job will be executed. Options
include:Daily/Weekly/Monthly.
File Format Select the format of the export file. Currently only the .CSV option is
available.
Server Type Determines the location of the export file. Options include:
File Directory Specify the directory where the export file is placed. In case Server
Type is set to Local Server, specify the relative to Magento
installation path. For example, var/export.
Failed Email Receiver Specify the email address to which an email notification (export failed
email) is sent if the export fails.
Failed Email Sender Specify the email address that is used as export failed email sender.
Failed Email Template Select a template for the failed export email. By default, only the
Export Failed (Default Template from Locale) option is available.
Send Failed Email Copy The email address to which a copy of the failed export email is sent.
To
Send Failed Email Copy Specify the copy sending method for the export failed email.
Method
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.
tax_class_name The name of the tax class that is associated with this
product.
price The price that the product is offered for sale in your store.
special_price_from_date The beginning date of the time period when the special
price is in effect.
meta_title 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.
base_image 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
small_image The file name of the small image that is used on catalog
pages, preceded by a forward slash. For example:
/image.jpg
small_image_label The label associated with the small image. For example:
Small Image 1, Small Image 2
created_at Indicates the date when the product was created. The
date is automatically generated when the product is
created, but can be edited later.
updated_at Indicates the date when the product was last updated.
new_from_date Specifies the “from” date for new product listings, and
determines if the product is featured as a new product.
new_to_date Specifies the “to” date for new product listings, and
determines if the product is featured as a new product.
related_skus Lists the sku of each product that has been identified as
a Related Product. For example:
24-WG080,24-UG03,24-UG01,24-UG02
crosssell_skus Lists the sku of each product that has been identified as
a Cross-sell.
upsell_skus Lists the sku of each product that has been identified as
an Upsell.
Complex Data
The term complex data1 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 Configurable
l Grouped
l Bundle
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.
CONFIGURABLE PRODUCTS
GROUPED PRODUCTS
associated_skus Identifies the SKUs of the individual products that make up the group.
BUNDLE PRODUCTS
bundle_values Describes teach value associated with a bundle option. For example:
name=Bundle Option One,type=dropdown; required=1, sku=sku-
option2,price=10, price_type=fixed
tier_price_website The website code identifies each website where tier pricing is
available. For example:
website1
All Websites [USD]
tier_price_customer Identifies the customers groups where tier pricing is available. For
example:
ALL GROUPS
NOT LOGGED IN
General
Wholesale
Retailer
tier_price_customer_ Identifies the customers groups where tier pricing is available. For
group example:
ALL GROUPS
NOT LOGGED IN
General
Wholesale
Retailer
tier_price The discounted tier price of the product. For bundle products, tier
price is calculated as a percentage.
group_price_website The website code of each website where group pricing is available. If
specifying multiple websites, separate each with a comma and
without a space. For example:
website1
All Websites [USD]
group_price_customer_ Identifies the customers groups where group pricing is available. For
group example:
NOT LOGGED IN
General
Wholesale
Retailer
group_price The discounted group price of the product. For bundle products, group
price is calculated as a percentage.
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.
_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
website_id
password
Customer Addresses
ATTRIBUTE DESCRIPTION
_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
_address_default_ Identifies the default billing address. A value of 1 indicates that the
billing_ address is the default billing address of the customer. Values: 1 / 0
_address_default_ Identifies the default shipping address. A value of 1 indicates that the
shipping_ address is the default shipping address of the customer. Values: 1 / 0
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.
1. On the Admin sidebar, tap System. Then under Extensions, choose Integrations.
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
l All
l Custom
b. For custom access, mark the checkbox of each resource that is needed:
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.
To learn more, see: “Restricting access to anonymous web APIs” in the Magento developer
documentation.
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.
Magento Marketplace
To learn more, see the Magento Marketplace User Guide.For extension installation instructions,
see Extensions Manager and Module Manager in this guide, or the Marketplace Quick Tour.
To install extensions:
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.
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 or stores, the websites and stores for
which they are not authorized will either not be visible to them or will be grayed-out as
inactive. Only the sales and other data for permitted websites and stores is displayed for the
user.
By default, the system automatically logs (records) all actions performed by a user when making a
change to a store. Admin actions can be reviewed in the Action Logs Report. Configure logging in
Admin Actions Logging in your store's advanced admin settings.
All Users
Adding Users
When your store is first installed, a default Admin account is created with login credentials
that 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 access. 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 based on their business need to know. 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 only to the necessary 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.
1. On the Admin sidebar tap System. Then under Permissions, choose All Users.
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.”
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.
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.
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.
Locked Users
For the security of your business, user accounts are locked by default after six failed attempts to
log in 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.
Locked Users
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
To set up a role:
1. On the Admin sidebar, tap System. Then under Permissions, choose User Roles.
2. In the upper-right corner, tap Add New Role. Then, do the following:
Role Name
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.
l All
l Custom
If set to “Custom” for a multisite installation, mark the checkbox of the website and store
where the role is to be used.
3. In the tree, mark the checkbox of each Admin Resource that the role can access.
To create an Admin role with access to tax settings, choose both the Sales/Tax and
System/Tax resources. If setting up a website for a region that differs from your default
shipping point of origin, you must also allow access to the System/Shipping resources for
the role. The shipping settings determine the store tax rate that is used for catalog prices.
The list of available permissions may include additional options for Magento developed, Core
Bundled, and installed extensions. By selecting the top-most permission for each feature, you
assign all permissions available for the user.
The role now appears in the grid, and can be assigned to new user accounts.
Editing a Role
The Role Users option appears only after a new role is saved.
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.
Role Users
Role Resources
Access to the following resources can be assigned to a custom role. See the linked page to learn
more about the capabilities that are associated with each role.
Role Resources
ROLE DESCRIPTION
Dashboard
Archive
Shopping Cart
Management
Catalog Inventory
Products
Categories
Now Online
Segments
My Account
Content Staging
Elements Pages
Hierarchy
Blocks
Banners
Widgets
Media Gallery
Design Themes
Schedule
Reports Marketing
Reviews
Sales
Customers
Products
Private Sales
Statistics
Tools Support
Cache Management
Web Setup Wizard
Backups
Index Management
Change Indexer Mode
Global Search
l Database
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 env.php 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 rewrites 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.
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:
c. Tap Synchronize to transfer the existing media to the newly selected database.
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.
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}}
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}}
l Security Scan
l CAPTCHA
l Two-Factor Authentication
l Encryption Key
l Action Log
Make sure to set up a Security Scan for each domain in your Magento installation. Also, visit
the Security Center and join the Security Alert Registry for the latest news about potential
vulnerabilities and best practices.
Security Center
Security Scan
Magento Security Scan allows you to monitor each of your Magento sites for known security
risks, and to receive patch updates and security notifications.
l Receive reports with the results of over thirty security tests and the recommended corrective
actions for each failed test.
The Security Scan tool is available for free from the dashboard of your Magento account. For
technical information, see Go live and launch in the developer documentation.
Security Scan
If you have multiple sites with different domains, you must configure a separate scan for each
domain.
Monitored Sites
4. Log in to the Admin of your store as a user with full Administrator privileges. Then, do the
following:
a. In the Admin sidebar, choose Content. Then under Design, choose Configuration.
d. Scroll down to Scripts and Style Sheets. Then, click in the text box at the end of any
existing code, and press Ctrl-V to paste your confirmation code into the text box.
5. Return to the Security Scan page in your Magento account. Then, tap Verify Confirmation Code
to establish your ownership of the domain.
6. After a successful confirmation, Set Automatic Security Scan to one of the following:
By default, the scan is scheduled to begin each week at midnight Saturday, UTC, and continue
to early Sunday.
Scan Weekly
Scan Daily
Choose the Time, and Time Zone that the scan is to take place each day.
Scan Daily
7. Enter the Email Address where you want to receive notifications of completed scans and
security updates.
Email Address
After the ownership of the domain is verified, the site appears in the Monitored Websites list of
your Magento account.
9. If you have multiple websites with different domains, repeat this process to set up a security
scan for each.
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.
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.
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: magento-
nginx.conf on GitHub.
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.
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 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 LastPass, 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. We recommend using SFTP over FTP for file
transfers.
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.
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 free Magento Security Scan Tool! Monitor your sites for
security risks, update malware patches, and detect unauthorized access with this tool.
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 disclose the password to your server or to the Magento Admin, unless you are
required to do so.
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.
Security Review
Check periodically for unauthorized Admin users.
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.
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 Site access is compromised, but often the payments information
is not. User accounts might be compromised.
Botnetting 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.
Direct Attack on Server 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.
Silent Card Capture 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.
7. Reset all credentials, including the database, file access, payment and shipping integrations,
web services, and Admin login.
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.
Additional Resources
For additional technical best practices and developer-centric information, see the following
information.
l The Magento Security blog investigates and provides insights to security issues, best
practices, and solutions for all of your security questions.
l Try out the free Magento Security Scan Tool! Monitor your sites for security risks, update
malware patches, and detect unauthorized access with this tool from Magento Commerce.
l Check all available Developer Tools through the Admin. These features can help test, verify,
and prepare your site and Admin for workloads and traffic.
l The Magento Community has limitless best practices, recommendations, and tutorials to
help get you started with Magento, maintaining your catalogs, and much more. Check out
the best Community Resources.
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 Dracony (@dracony_gimp) for his security presentation, Being Hacked is Not Fun.
DIAGNOSE. Run a scan to establish the security status of your Magento store.
MageReport.com is a highly regarded service that is available at no charge to members of
the Magento community.
CLEAN. Hire a qualified consultant or online service to clean your site of all malicious
code. Some Magento community members recommend Sucuri Website Malware
Removal.
l Remove all unknown Admin users and reset all Admin passwords.
PROTECT. Keep your Magento installation up-to-date with the most current release. If
using an older version, apply all security patches as they become available.
REPORT. If you think that you have found a specific vulnerability in Magento, send a
description of the problem with technical details to [email protected].
UPGRADE. For additional peace of mind that comes from 24/7 support, plan your
upgrade now to Magento Commerce Cloud.
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 CAPTCHA.
Security
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 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.
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.
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.
Forced Requires that Admin users change their passwords after the account is
set up.
Recommended Recommends that Admin users change their passwords after account is
set up.
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.
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.
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
l Admin Login
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.”
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
l Payflow Pro (Requires installing a patch according to KB PayPal Payflow Pro active carding
activity.)
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.
l Create User
l Login
l Forgot Password
l Checkout as Guest
l Payflow Pro (Requires installing a patch according to KB PayPal Payflow Pro active
carding activity.)
After number Enter the number of login attempts before the CAPTCHA appears. A
of attempts value of 0 (zero) is similar to “Always.” When selected, the number of
to login 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.”
Google reCAPTCHA
Google reCAPTCHA ensures that a human being, rather than a computer, is interacting with
the site. It provides enhanced security over Magento CAPTCHA, performs checks without
potential user error when entering a series of letters and numbers, and encourages cart
conversion without additional hurdles to complete a purchase.
l reCAPTCHA v2 verifies users and customers using an on-click feature proving "I am not a
robot."
You can use Google reCAPTCHA on the Admin Sign In page, and on various customer pages in
the storefront. The styling options include your choice of a light or dark theme, and either a
compact or normal size.
If you have the standard Magento CAPTCHA enabled, reCAPTCHA will override it. You can
have both enabled on your Magento instance without issues.
Google reCAPTCHA requires a pair of API keys to enable. You can get these keys free of charge
through the reCAPTCHA site. Before generating the keys, consider the type of reCAPTCHA you
want to use.
1. Visit the Google reCAPTCHA page, and log in to your account. Then, do the following:
a. Enter a Label for the keys. For example, enter Magento. You only need one set of keys for
your entire Magento instance.
c. In the Domains text box, enter a list of domains without the HTTP or HTTPS prefix, one
per line. Google verifies the addresses entered.
l You can add localhost, other local VM domains, and staging domains as needed for
testing.
e. (Optional) Mark the Send alerts to owners checkbox to send notification if Google detects
issues or suspicious traffic.
a. When the domain(s) you added appear at the top of the page, choose the Magento domain
to get your keys.
b. Scroll down to the Adding reCAPTCHA to your site section and expand Keys. You will
need these keys when enabling Google reCAPTCHA.
1. Sign in to the Admin of your Magento store. On the Admin sidebar, tap Stores. Then under
Settings, choose Configuration.
3. In the panel on the left under Security, choose Google reCAPTCHA. Then, expand the
General section, and enter the following generated keys:
b. To change the Theme, clear the Use system value checkbox. Then, choose one of the
following:
l Light
l Dark
c. To change the Size, clear the Use system value checkbox. Then, choose one of the
following:
l Normal
l Compact
5. Expand ( ) the Frontend section. Then, do the following to add Google reCAPTCHA to
customer accounts:
b. Choose the reCAPTCHA type you want used in Admin forms. You must have added the
correct API keys for the type.
c. To change the Theme, uncheck Use system value checkbox and select a Light or Dark
Theme from the drop-down menu.
d. To change the Size, uncheck Use system value checkbox and select a theme from the
drop-down menu: Normal or Compact.
e. Select when to use reCAPTCHA for customer accounts. By default, reCAPTCHA is enabled
for these pages.
l Use in Login
l Use in Contact
Two-Factor Authentication
The Magento Admin provides all access to your store, orders, and customer data. To further
increase security to your Magento instance, Magento Two-Factor Authentication (2FA) adds
support for two-step authentication for multiple providers. When enabled, users attempting to
access the Admin must complete a second step to verify their account. All features and
requirements are restricted to Admin user accounts, not extended to customer accounts.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
3. Expand ( ) the General section, if necessary. Then, set Enable Two Factor Auth to “Yes.”
4. (Optional) For Force Providers, select the authenticators you require for all users. To allow
users to select their own authenticator, do not select an option.
5. Enable and configure each authentication provider that you support. Each enabled
authenticator becomes a supported option for user accounts.
Google Authenticator
2. (Optional) Set Enable “trust this device” option to one of the following:
Yes The user does not have to enter their authenticator code for every login per device.
Google Authenticator
2. (Optional) Set Enable “trust this device” option to one of the following:
Yes The user does not have to enter their authenticator code for every login per device.
U2F Devices
Duo Security
2. (Optional) Set Enable “trust this device” option to one of the following:
Yes The user does not have to enter their authenticator code for every login per device.
l Integration key
l Secret key
Duo Security
Authy
3. (Optional) Set Enable “trust this device” option to one of the following:
Yes The user does not have to enter their authenticator code for every login per device.
4. (Optional) To change the OneTouch Message, clear the Use system value checkbox.
Then, enter the message that you want to use.
Authy
Set required authenticators Supports multiple types of authenticators and allows you to set an
per user account authenticator per account depending on user or office needs.
Force global authenticator Strictly requires all Magento Admin users to access using the
for all accounts selected authenticator(s).
We recommend only enabling one authenticator per account. If you require multiple
authenticators, the user must authenticate with each one. For example, if you select Google
and U2F, the user must access with a Google Authenticator code and connect a U2F device.
1. On the Admin sidebar, tap System. Then under Settings, choose All Users.
4. Mark the checkbox of the authenticator that you want to require for the user account. The list
includes all enabled and configured authenticator providers.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2. In the panel on the left under Security, choose 2FA. Then, do the following:
a. In the General section, clear the Use system value checkbox for Force providers.
Using Two-Factor-Authentication
Follow the instructions for the method of authentication that you want to use.
U2F Key
With the U2F device configured, the user attaches the device to their system when logging into
the Admin. For more information, check your U2F vendor documentation, such as YubiKey by
Yubico.
2. Press the button on the key. Authentication immediately triggers and opens the Admin.
Google Authenticator
3. Tap the plus sign ( + ) to add a new entry. Then, do the following:
a. Line up the red box with the QR code to scan with the camera on the mobile device.
b. When it recognizes the QR code and adds an entry, enter that 6-digit code in the Admin
Authenticator code field.
4. To save the authentication for future logins, mark the Trust this device, do not ask again
checkbox.
Authy
The Authy authenticator includes multiple types of apps available from this page, including:
Mobile App, Desktop App, and Chrome App. For details on setup, see Authy documentation.
Authy registration
l SMS
l Call Me
d. Tap Continue.
3. Enter the Verification code that you receive, and tap Verify. Then when prompted, tap
Confirm.
Authy access
Use one touch Sends an alert to your Authy app. In the app, accept the access.
Use authy token Prompts to enter a code from your Authy app.
3. The app includes additional emergency methods if you have trouble signing in. Choose the
method you want to use to receive the code. Then, enter the code that you receive to access the
Admin.
Send me a code via A text SMS message is sent to the configured mobile device.
SMS
Send me a code via The user receives a phone call with a code.
phone call
Duo
The Duo Mobile app is available through Google Play or iOS App Store. To use, it must be
activated and linked to an account. For details, your security staff should obtain a Duo
account and complete setup.
2. When the Duo Setup page appears. tap Start setup. Then, do the following:
Duo Setup
Device Type
This example requests your phone number, because we’re using a mobile device.
c. When prompted to install Duo Mobile for your phone type, tap I have Duo Mobile.
3. Open Duo Mobile, and scan the QR code to sync the authenticator with Magento. A
checkmark appears when the activation is complete.
4. To configure your settings for the device, choose the action that you want to take place when
you sign in.
Ask me to choose an Allows the user to select when logging in and authenticating in the
authenticator method Magento Admin.
Automatically send this Sends a message to your device to accept or deny for access.
device a Duo Push
The following example displays the options when selecting Ask me to choose an authenticator
method:
Duo access
Send Me a Push Tap to receive a push notice to Duo Mobile. Accept to authenticate.
Call Me Tap this option, receive a call with a code, and enter the passcode.
If you have issues accessing the Magento Admin with the authenticators, consider the
following:
l Some mobile apps include options to sync. This option reconnects the app and server,
updating in case time settings changed on the device or server.
l Clearing web cache and cookies for the Magento instance can also help. Authenticators, like
Google, use generated cookies to save access and duration. Clear your cookies for your
specific browser and Magento instance domain.
l If you have blocked cookies for your browser, this will block some authenticators, like
Google, from completing verification and access. Add a rule to allow cookies for your
Magento instance.
1. On the Admin sidebar, tap System. Then under Permissions, choose All Users.
2. Select and edit a user from the list or add a new user account.
3. Tap 2FA.
These entries detect the device and allow log in access without requiring authentication. The
entries include the last IP address, the data and time of access, and a description including the
type of system (Mac, PC, tablet, etc) and browser with version.
After revoking a listed device, the user must authenticate again if accessing the Admin from it.
1. On the Admin sidebar, tap System. Then under Permissions, choose All Users.
3. Tap 2FA.
4. In the Trusted devices grid, locate a device to remove from the account. Then, tap Revoke.
If the user accesses the Admin from this device again, they must authenticate regardless of any
cookies with active duration.
To disable 2FA:
If you have issues with 2FA, you can disable it from command-line. This will disable 2FA
globally.
Disable Module
Examples
Reset Google Authenticator
Reset Authy
In your database, you can modify the following tables and values to affect and override 2FA.
We advise caution when making any changes directly to your database.
Table: core_config_data
Table: msp_tfa_user_config
Delete one user row to reset the user's 2FA preference and configuration.
Encryption Key
Magento uses an encryption key to protect passwords and other sensitive data. An industry-
standard Advanced Encryption Standard (AES-256) algorithm is used to encrypt all data that
requires decryption. This includes credit card data and integration (payment and shipping
module) passwords. In addition, a strong Secure Hash Algorithm (SHA-256) is used to hash all
data that does not require decryption.
During the initial installation, you are prompted to either let Magento generate an encryption
key, or enter one of your own. The Encryption Key tool allows you to change the key as needed.
The encryption key should be changed on a regular basis to improve security, as well as at any
time the original key might be compromised. Whenever the key is changed, all legacy data is
re-encoded using the new key.
For technical information, see Install the Magento software in the developer documentation.
Encryption Key
To change the encryption key, make sure that the following file is writable:
[your store]/app/etc/env.php
1. On the Admin sidebar, tap System. Then under Other Settings, choose Manage Encryption
Key.
l To use a different key, set Auto-generate Key to “No”. Then in the New Key field, enter or
paste the key that you want to use.
4. Keep a record of the new key in a safe place. It will be required to decrypt the data, if any
problems occur with your files.
Session Validation
Magento Commerce 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.
For technical information, see Use Redis for session storage in the developer documentation.
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.
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.
l If the browser’s privacy settings disallow cookies, you can configure the system to
automatically redirect them to the Enable Cookies 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:
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.”
l Cache Management
l Index Management
l Backups
l Developer Tools
l Support
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.
After clearing a cache, always refresh your browser to make sure that you can see the most
recent files. Clearing the Magento cache does not clear your web browser cache. You may need
to clear the browser cache to see updated content.
Access to specific cache maintenance actions can be assigned to users by role, including options
to view, toggle, and flush caches. Magento recommends only enabling flush actions to
administrator level users. Providing access to all Cache Management features can impact your
storefront's performance.
Cache Management
l Always flush the cache after installing extensions/modules. You can install one or more
extensions, then flush the cache.
l Flush the cache after installing Magento Commerce. For fresh installs, you should also
reindex.
l Flush the cache after upgrading from one version of Open Source or Commerce to another.
l When flushing caches, consider the type of cache and scheduling the flushing during non-
peak times. For example, pick a time when few customers may access the site such as late
night or early morning. Clearing some cache types during peak times cause result in a high
load on the Admin and may result in a down site until completed.
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.
l Select All
l Select Visible
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.
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.
Control Descriptions
CONTROL DESCRIPTION
Mass Actions Marks the checkbox of multiple caches. Options include:
Button Descriptions
BUTTON DESCRIPTION
Flush Magento Cache Removes all items in the default Magento cache (var/cache),
according to their associated Magento tags.
Flush Cache Storage Removes all items from the cache, regardless of Magento tag. If your
system uses an alternate cache location, any cached files used by
other applications are removed in the process.
Flush Catalog Images Removes all automatically resized and watermarked catalog images
Cache that are stored at: media/catalog/product/cache.
If recently uploaded images aren't reflected in the catalog, try flushing
the catalog and refreshing your browser.
Flush JavaScript/CSS Removes the merged copy of JavaScript and CSS files from the
Cache 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.
Flush Static Files Cache Removes preprocessed view files and static files.
Cache Descriptions
CACHE DESCRIPTION
Configuration Various XML configurations that were collected across modules and
merged. Associated Tag: CONFIG
System: config.xml
local.xml
Module: config.xml
Reflection Data Clears API interface reflection data, that is typically generated during
runtime.
Database DDL operations Results of DDL queries, such as describing tables or indexes.
Associated Tag: DB_DDL
EAV types and attributes Entity types declaration cache. Associated Tag: EAV
Full-Page Cache
Magento Commerce uses full-page caching on the server to quickly display category, product,
and CMS pages. Full-page caching improves response time and reduces the load on the server.
Without caching, each page might need to run blocks of code and retrieve information from the
database. However, with full-page caching enabled, a fully-generated page can be read directly
from the cache.
Cached content can be used to process the requests from similar types of visits. As a result,
pages shown to a casual visitor might differ from those shown to a customer. For the purposes
of caching, each visit is one of three types:
Non-sessioned During a non-sessioned visit, a shopper views pages, but does not
interact with the store. The system caches the content of each page
viewed, and serves them to other non-sessioned shoppers.
Sessioned During a sessioned visit, shoppers who interact with the store—through
activities such as comparing products or adding products to the
shopping cart—are assigned a session ID. Cached pages that are
generated during the session are used only by that shopper during the
session.
Customer Customer sessions are created for those who have registered for an
account with your store and shop while logged in to their accounts.
During the session, customers can be presented with special offers,
promotions, and prices that are based on the customer group to which
they are assigned.
For technical information, see Configure and Use Varnish and Use Redis for the Magento page
and default cache in the developer documentation.
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)
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.
Varnish Configuration
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.
Magento reindexes 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. All indexes can use either
option, except Customer Grid which only supports on save. When indexing on save, Magento
starts a reindex on save actions. The Index Management page will update and flush the reindex
message within a minute or two. When reindexing on a schedule, a reindex runs according to a
schedule as a cron job. A system message appears if a cron job is not available to update any
indexers that become invalid. Your store remains accessible during reindex processes.
When you need to reindex, a notification appears at the top of the page. The index and
message clears based on the reindex mode and potential actions you take.
Reindex notification
For technical information, see Indexing overview in DevDocs developer documentation.
Index Management
Index Management has a slightly different presentation for flat product catalogs.
To avoid problems when multiple Admin users update objects that trigger automatic
reindexing, we recommend that you set all indexers to run on schedule as cron jobs.
Otherwise, every time an object is saved, any objects with interdependencies might
cause a deadlock. Symptoms of a deadlock include high CPU usage and MySQL errors.
As a best practice, we recommend that you use scheduled indexing.
By default, admin actions, such as reindexing, are logged by the system and can be viewed in the
Action Logs Report. Action logging can be configured in the Admin Actions Logging in your store's
advanced admin settings.
l If you have a large store or multiple stores, you may want to set indexers like category and
products to scheduled cron jobs due to potential reindex looping. You may want to set the
reindex on a schedule during non-peak hours.
l For fresh Magento installations, you need to flush the cache and reindex.
l Flushing caches and reindexing does not flush your computer's web browser cache. We
recommend also flushing the browser cache after completing updates to your storefront.
l Update on Save
l Update by Schedule
Important: Customer Grid can only be reindexed using "Update on Save". This index does not
support "Update by Schedule".
Column Descriptions
COLUMN DESCRIPTION
Indexer The name of the indexer.
Mode Indicates the current update mode for each indexer. Options:
Updated Indicates the date and time an index was last updated.
Catalog category/product Add, edit, or delete products (single, mass, and import)
index Change product-to-category relations
Add, edit, or delete categories
Add or delete stores
Delete store groups
Delete websites
Catalog search index Add, edit, or delete products (single, mass, and import)
Add or delete stores
Delete store groups
Delete websites
Category permissions Add store, add store group, add or delete or update attribute (for
index searching and filtering)
1 The flat product and category indexers also influence how catalog and shopping cart price rules are indexed. If
you have a large number of SKUs (about 500,000 or more), you will notice a dramatic improvement in indexing time
for price rules. To take advantage of this improvement, you must enable Use Flat Catalog Product.
Bulk loading of items in the Partial reindex (only At the frequency determined by your
following ways: changed items are Magento cron job.
reindexed)
l Magento import/export
Changing scope (for Partial reindex (only At the frequency determined by your
example, from global to changed items are Magento cron job.
website) reindexed)
INDEXER EVENT
Catalog Category Flat Create a new web store
Indexer Create a new web store view
Create, or delete an attribute that is any of the following:
l Filterable
l Filterable in search
INDEXER EVENT
l Searchable or visible in advanced search
l Filterable
l Filterable in search
Stock status indexer When the following Catalog Inventory options change in the system
configuration:
Backups
Magento Commerce gives you the ability to backup different parts of the system—such as the
file system, database, and media files—and to roll back 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 backup before installing extensions and updates.
Restrict access to backup tools. Access to the Backups and roll back management tool
can be restricted by configuring user permissions for backup and roll back resources. To
restrict access, leave the corresponding checkbox unselected. If you need to grant access
to roll back resources, you must grant access to backup resources as well.
backup before installing extensions and updates. Always perform a backup before you
install an extension or update. Extensions Manager and Module Manager include a backup
option that you can use before installing an extension or upgrading to a new release.
Deprecation Notice! Magento backup features are deprecated as of v2.3.0. We recommend that
all merchants investigate additional backup technologies and binary backup tools (such as Percona
XtraBackup).
Backups
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.
Database and Creates a backup of the database and the media folder.
Media Backup
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.
l Email
l Newsletters
l XML Sitemap Generation
In addition, you can configure the following to run according to a cron schedule:
Make sure that the base URLs for the store are set correctly, so the URLs that are generated
during cron operations are correct. For technical information, see: Set up cron jobs.
To configure cron:
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
4. Then, complete the following settings for the Index and Default groups. The settings are the
same in each section.
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 Action Logs
l Amazon Logs
l File Optimization
l Translate Inline
Action Logs
The Action Logs feature records (logs) every change made by an admin who works in your
store. This allows you to track all the changes made to your store. Tracking these changes,
along with setting admin permissions for a user, can help to secure your store from unwanted
changes.
For most admin actions, the logged information includes the action, the name of the user who
performed the action, whether the action was a success or failure, and the ID of the object on
which the action was performed. The IP address and date are also always logged.
By default, all admin actions are enabled and logged. To configure Admin Actions Logging,
review the options and check or clear the checkbox per action types. Magento only logs checked
types.
View the Action Logs Report to review logged admin actions and details.
1. On the Admin sidebar, click Stores. Then under Settings, choose Configuration.
3. Expand the Admin Actions Logging section. Then for each action, do the following:
Actions that you want to display in the report must be enabled in the Admin Actions Logging
screen in the store settings. If the action type is checked (enabled), those types of admin
actions will display in the Action Logs Report.
The report can be filtered using the options in each column. You may set a single filter option
or set filter options for multiple columns to narrow the report to list specific actions. You can
also export report data in either CSV or Excel XML format.
l Action Group: Displays the action type, correlates to the actions enabled on Admin Actions
Logging screen in your store settings
l IP Address: Displays the IP address for the machine on which the action was performed
l Username: Displays the login ID for the user who performed the action
To clear the filter options and return to the full report, click Reset Filter.
Filter by Field
FIELD DESCRIPTION
Time In From, click to select a date from the dynamic calendar to
define the beginning date for the filter. Then in To, click to select
a date from the dynamic calendar to define the ending date for
the filter.
Full Action Name Enter text for the search to match in the field.
2. Click Export. The generated file saves automatically to your designated folder for downloads.
Archive
The Admin Actions archive lists the CSV log files that are stored on the server. In the
configuration, you can specify how long the log entries are stored, and how often they are
archived. By default, the file name includes the current date in ISO format: yyyyMMddHH.
2. Expand the Admin Actions Log Archiving section, and do the following:
a. In the Log Entry Lifetime, Days field, enter the number of days that you want to keep the
log entries in the database before they are removed.
l Daily
l Weekly
l Monthly
Bulk Actions
The Bulk Actions Log records the details of asynchronous mass operations that run in the
background, such as import/export.
1. On the Admin sidebar, click Stores. Then under Settings, choose Configuration.
4. In the Days Saved in Log field, enter the number of days that bulk actions are saved in a log.
Bulk Actions
INP Logs all Instant Payment Notifications that are sent by Amazon.
If logs are not available or have not been generated, a message displays "No logs are currently
available."
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
Client side less Compilation takes place in the browser using the native less.js library.
compilation
Server side less Compilation takes place on the server using the Less PHP library. This is
compilation the default mode for production.
For technical information, see Static content signing in the developer documentation.
The Static File Settings configuration is available only when working in developer mode.
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.
For technical information, see Magento Optimization Guide in the developer documentation.
l Minify
l Bundle
l Minify
CSS Settings
JavaScript Settings
Template Settings
For technical information, see Custom whitelist VCL in the developer documentation.
4. In the Allow IPs field, enter your IP address. If access is needed from multiple IP addresses,
separate each with a comma.
For technical information, see Locate templates, layouts, and styles in the developer
documentation.
1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
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.”
5. When you are finished, return to the Admin to disable the hints and clear the cache.
1. On the Admin sidebar, tap System. Then under Tools, choose Cache Management.
Translate Inline
You can use the Translate Inline tool in developer mode to touch up text in the interface to
reflect your voice and brand. When the Translate Inline mode is activated, any text on the page
that can be edited is outlined in red. It’s easy to edit field labels, messages, and other text that
appears throughout the storefront and Admin. For example, many themes use terminology
such as “My Account,” “My Wishlist,” and “My Dashboard,” to help customers find their way
around. However, you might prefer to simply use the words “Account,” “Wishlist,” and
“Dashboard.”
The Translate Inline tool is available only when working in developer mode.
Translatable Text
If your store is available in multiple languages, you can make fine adjustments to the
translated text for the locale. On the server, interface text is maintained in a separate CSV file
for each output block, and is organized by locale. As an alternate approach, rather than use the
Translate Inline tool, you can also edit the CSV files directly on the server.
To use the Translate Inline tool, your browser must allow pop-ups.
1. On the Admin sidebar, tap System. Then under Tools, choose Cache Management.
l Blocks HTML output
l Page Cache
l Translations
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.
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
7. When prompted, refresh the invalid caches, but leave the disabled caches as they are for now.
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.
3. To see your changes in the store, press the F5 key to refresh the browser.
1. Return to the Admin of your store. On the Admin sidebar, tap Store. Then under Settings,
choose Configuration.
Translate Inline
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
Customer Sign In
Setup Wizard
The Setup Wizard can be used to easily install and uninstall components, modules, and
extensions, manage modules, upgrade your installation, and make changes to the Web setup of
your installation.
Important: Always flush the cache after installing or upgrading Magento, or any extensions and
modules.
Setup Wizard
Setup Tools
Extension Manager
Extension Manager lists each component that is
currently installed, and can be used to synchronize any
extensions you have purchased from Magento
Marketplace with your system.
Module Manager
Module Manager lists the components and modules that
are currently installed in your Magento system.
System Upgrade
The System Upgrade tool can be used to upgrade your
installation of Magento. During the process, it checks
your system for readiness, creates a backup, and then
upgrades your system.
System Config
The System Config tool uses the public and private keys
from your Marketplace account to synchronize web setup
operations.
Extension Manager
Installing an extension is a three-step process that should take place during off-peak hours.
Before the extension is installed, your store is put into maintenance mode, checked for
readiness, and backed up. After the extension is installed, it must be configured for your store
according to the developer’s instructions.
For technical information, see Run the Extension Manager in the developer documentation.
Important: Always flush the cache after installing or upgrading Magento, or any extensions and
modules.
Installed Extensions
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.
a. Go to Magento Marketplace. Then in the upper-right corner, log into your account.
b. On the Marketplace tab of your account, under My Products, click Access Keys.
c. If you need to generate a new set of access keys, tap Create a New Access Key.
d. Find the set of access keys in the list. Then, copy and paste your Public Key and Private
Key into Extension Manager.
e. Tap Submit.
Extension Manager
It will take a few minutes to generate the summary and list of all available updates, recently
purchased extensions, and currently installed extensions and sample data.
4. In the summary at the top of the page, under Extensions Ready to Install, tap Review and
Install. Then, do the following:
a. In the list of extensions that are ready to install, mark the checkbox of the extension that
you want to install.
b. In the Latest version column, choose the version that you want to install. Then in the
Action column, click Install.
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
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.
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.
3. In the upper-right corner of Extension Manager, click the Reset link to log out.
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.
Module Manager
Module Manager lists the components and modules that are currently installed in your
Magento system. Before a module is disabled, the system completes a readiness check and
creates a backup.
l The colored dot in the first column indicates if the module is currently “on” or “off”.
l Click the down arrow before the component name to list any dependent packages that are
associated with the module.
For technical information, see Run the Module Manager in the developer documentation.
Important: Always flush the cache after installing or upgrading Magento, or any extensions and
modules.
Module Manager
To disable a module:
1. Find the module in the list.
2. In the Action column, click Select. Then, click Disable, and do the following:
a. Under Step 1: Readiness Check, tap Start Readiness Check to verify that your installation
has the correct version of PHP and required extensions and file permissions.
Readiness Check
When the readiness check is complete, do one of the following:
l Tap Next.
b. Under Step 2, mark the checkbox of each Backup Option that you want to include. Then,
tap Create Backup.
Create Backup
Before the backup is created, the available disk space is checked, and the store is placed in
maintenance mode. It might take several minutes — or more — to create the backup,
depending on the size of your database.
Backup Complete
Disable Module
d. As the process is running, the details appear in the box below. To toggle the display of the
log, tap Console Log.
e. When the Success page appears, the module is disabled and your store returns to
production mode. Tap Back to Setup Tool to return to Module Manager.
Success
In the Module Manager list, the red dot in the first column means the module is now
disabled.
Module Disabled
To enable a module:
1. Find the module in the list.
2. In the Action column, click Select. Then, click Enable and do the following:
Enable Module
When the readiness check is complete, do one of the following:
l Tap Next.
b. Under Step 2, mark the checkbox of each Backup Option that you want to include. Then,
tap Create Backup.
Create Backup
Enable Module
e. As the process is running, the details appear in the box below. To toggle the display of the
log, tap Console Log.
f. When the Success page appears, the module is enabled and your store returns to
production mode. Tap Back to Setup Tool to return to Module Manager.
System Upgrade
The System Upgrade tool can be used to upgrade your Magento installation from the Admin.
The upgrade is a three-step process that should take place during off-peak hours. Before
upgrade takes place, your store is put into maintenance mode, checked for readiness, and
backed up.
We strongly recommend reviewing the latest release notes and system requirements.
Upgrade Requirements
l Only the primary account holder is authorized to download code from the repository.
l The authorization keys that are used to download code must be generated from the primary
account.
l The merchant or developer must submit a ticket to Support and request authorization for
the download.
Important: Always flush the cache after installing or upgrading Magento, or any extensions and
modules.
For developer information on upgrades, see the DevDocs Command Line Upgrade. The upgrade
instructions include scripts to help run and complete your upgrades. These steps will require
developer assistance.
System Upgrade
2. On the Admin sidebar, tap System. Then under Tools, choose Web Setup Wizard.
System Upgrade
4. When prompted, follow the instructions to copy and paste the Public Access Key and Private
Access Key from your Marketplace account. Then, tap Submit.
System Config
To sync and add extensions, modules, and components from Magento Marketplace to your
Magento Admin, you need to add and sync Marketplace access keys. The System Config page of
the Web Setup Wizard saves allows you to add these keys and sync with Marketplace.
You need to generate, copy, and paste Marketplace access keys from your Marketplace account
to the Magento Admin. Once added, the services will remain in sync, including your purchased
and added extensions.
2. To access your Magento authentication keys, tap the Developertab then Access Keys.
3. Copy the Public Access Key and Private Access Key from your Marketplace account.
4. In the Magento Admin, tap System > Web Setup Wizard, and then tap System
Configuration.
5. Then, tap Submit. The keys are saved, only revealing the public key.
l Data Collector
l System Reports
Data Collector
Data Collector gathers the information about your system that is needed by our Support team
to troubleshoot issues with your Magento installation. The backup that is created takes several
minutes to complete, and includes both a code and database dump. The data can be exported
to a CSV or Excel XML file.
Data Collector
1. On the Admin sidebar, tap System. Then under Support choose Data Collector.
It will take a few minutes to generate the backup. When complete, the backup appears in the
Data Collector grid.
Log
Export Format
3. Look for the download message at the bottom of the screen, and Save the file.
System Reports
The system reporting tool gives you the ability take periodic full, or partial, snapshots of the
system, and save them for future reference. You can compare performance settings before and
after code development cycles, or changes to server settings. The system reporting tool can
dramatically reduce the time spent preparing and submitting the information required by
Support to begin an investigation.
From the System Reports grid, you can view and download existing reports, delete reports, and
create new reports.
2. To generate a new system report, tap New Report. Then, do the following:
a. In the Groups list, select each set of information that you want to include in the report.
By default, all groups are selected.
3. To view the report, click the View link at the end of the row.
4. To download a report, click the Download link at the end of the row.
5. To create a new report, click the New Report button. Then, do the following:
a. In the list, select the Groups of system information that you want to include in the report.
Select Groups
It might take a few minutes for the report to generate, depending on the number of report
types selected. When the report is ready, it appears at the top of the grid with the date and
time generated..
l View
l Delete
l Download
7. In the panel on the left, expand each section of the report to view the detail.
8. To save the report as an HTML file, tap Download. Then save the file to your computer.
9. To view the report, open the download file in a browser. In the header, tap the control to jump
to a specific section of the report.
System Reports
REPORT GROUP INFORMATION INCLUDED
General Magento Version
Data Count
Cache Status
Index Status
Configuration Configuration
Data from app/etc/env.php
Shipping Methods
Payment Methods
Payments Functionality Matrix
2437
Contents Release Notes
Change Log
Glossary
Configuration Reference
2438
APPENDIX A:
Release Notes
Release notes provide a detailed description of each product release, with links to additional
technical information, installation instructions, and support resources. For details about the
most current and past releases, see Release Information.
As a best practice, we recommend that you keep your Magento installation up to date, so you
can benefit from the latest features and advancements.
Change Log
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.
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.
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.
broken link
A hyperlink that fails to send the user to its intended web page.
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.
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.
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 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.
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 4-
digit 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.
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.
EAV
Entity Attribute Value
evergreen content
Content that has a long shelf life.
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.
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.
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.
invoice
A document that provides a detailed description of a purchase, including products purchased,
quantity, price, shipping cost, sales tax, and total.
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.
keyword
A term or phrase used in a search to filter for content that is of significant importance to that term
or phrase.
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.
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.
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.
opt-in
The process by which a user consents to receiving emails from an online store.
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.
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.
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.
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.
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.
theme
A package that contains graphics and appearance information, and customizes the look and feel
of the store.
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.
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.
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.
XML
Extensible Markup Language: A markup format derived from SGML that it used to format
information for publication and distribution.
From the HTML version of the guide, you can drill down through any section of the reference,
and follow the links to corresponding topics in the user guide. From step-by-step instructions,
click any linked caption below a screenshot to jump to the field descriptions.
Follow these links for the corresponding section in the online reference:
l General
l Security
l Catalog
l Customers
l Sales
l Engagement Cloud
l Services
l Advanced
Configuration
1 Account
share 19
2
Account, Magento 16
2 Columns
Archive 2397
with Right Bar 431, 1507
Report 2394
2FA 2349
Actions
control 57 , 74
3
Actions, Mass 76
3 Column Layout 1508 , 1511
Add
Banner 1240
4 Address
A Admin 50 , 74
access 2303
Abandoned carts 1664
account 53
2454
Index
Amazon Store
permissions 2303
Setup 927
reCAPTCHA 2344
Analytics 38 , 46
role 2304
Anchor
role, create 2307
category 1245
role, custom 2309
Anchor category 412
security 2323
Android, email 607
session lifetime 79
Antivirus software 127
sidebar 54
AOV 40
Startup Page 64
API 47 , 2297
Startup Page, change 56
APNG file format 104
URL, custom 2121
Append Complex Data 2268 , 2271
user 2304
Apple Mail 607
user, create 2304
Approve product review 487-488
Admin Actions
Archive
Archive 2397
Admin actions 2397
Admin Startup Page 54
Assisted Shopping 1670
Advanced Admin, configuration 51
Asynchronous indexing 1727
Advanced Inventory 312
Attribute
Allow
Prodct, reference 2278
cookies 1664
Product, create 440
Base
Attributes 2202
currency 2200
Customer 2203
image 383
Date and Time 455
Best practice
Direct Post Method 1896
industry 126
Auto-generated fields 159
Best practices
Automatic
Security 2328
redirect 796
Best Practices
refund 1783
Product Attributes 2482
Automatic Sort 428
Product Categories 404
Automatic Sort, Visual Merchandiser 427
Bestsellers 65
Autosettings, product 264
Billing
Backup
reference 1245
delete 2388
Block reference 1226, 1513, 1523
Bank Transfer Payment 1918
category 1221
banner 1239
CMS pages 1221
Banner
product page 1222
create 1240
Blog, as Home page 1172
Customer Segment 1628
Capture
Blog, Magento 4-5, 7
Offline 1736
Braintree 1803, 1827
Events 590
C
flat 457
Cache 2372
images 379
JavaScript 2375
indexing 457
Storage Management 2372
New Products List 1250
Callout 1226
Price Rules 492, 494
Campaign, edit 1544
Product Link 1250
Campaign, preview 1547
Catalog page 28
Canada
Catalog Prices, display 2155
Example Tax Configuration 2180
Catalog Prices, tax 2175
Canada, PayPal solutions 1860
Catalog, menu 145
Canadian tax 2175
Categories
Cancel
Custom Design 431
order 1682
Display Settings 419
Canceled, order status 1719
Events 588
Canonical meta tag 148 , 784
Scheduled Changes 417
CAPTCHA 2339, 2343
Category
configuration, Admin 2340
Automatic Sorting 426
configuration, store 2342
Content Settings 418
Category Products 152-153, 425, 553, 1174, 1703 Page Versioning 1202
Code
CDN 2319
Column 1505
media retrieval 2319
sort 70
Change Log 2441
Community 46
Check / Money Order 1914
Cookie
Complete, order status 1719, 1732
domain 133
Complex data 2289
law 131
Compliance, industry 126
lifetime 133
Conditions, price rule 513
persistent 1664
Configurable Product 162, 171
session 1664
image 184
Country Options 85
security 2323
code 630
Configurations, add 176
Credit 1781
Consulting 6
card 1863
Contact Us 91
memo 1769
Content 1162, 1164, 1169
Credit Memo
Area 1243
Print 1778
Delivery Network 2319
Cron 2390
management system 39
Cron job 457 , 630
menu 54
Cron Settings, orders 1726
page 1183
Cross-border trade 2137
Content Staging 1535
Cross-sells 250 , 254, 483
Content, Product 245
rules 542
Conversion page 834
CSS Customer
Custom
retention 44
Design
segment 40
Category 430
Service page 1170
layout 431
Support 89
Layout Update
Customer Account
Layout Update, category 431
Gift Registry 561
Theme 431
Update 1583
URL 38
Customer Attributes 2203, 2293
variable 718
Customer Group
Custom Options 257
Events 588
Attributes 1619
Demo
Customers 65, 1550
login 51
menu 54
product 263
D Schedule 1533
Display
backup 2389
Gift Card Prices 1662
compression, backup 2388
Gift Wrapping Prices 1662
media storage 2317
in Suggested Terms 775
Date and Time Options 455
Mode, category 419
Date, input type 454
not required State 84
Day of Week 83
Settings
Default
Category 419
Config 111
Store Demo Notice 108
Country 85
Distributing newsletters 709
Display Currency 2200
Documentation 4
Title, page 1501
Dynamic
email, browsers 608
Encryption 127
Equalize
ECG 6
Price Ranges, layered navigation 755
Eco tax 2149
Product Counts, layered navigation 755
Ecosystem, Magento 7
Escape special characters 2243, 2254
Editor, WYSIWYG 1196
EU Member Countries 2172
Elasticsearch 768
EU Place of Supply 2148
Email
European Union
a Friend 469-470
Example Tax Configuration 2185
a Friend, configure 470
Event
addresses, domain 89
Components 588
addresses, store 89
Configure 590
campaign 44
Create 593
CSS file 610 , 621, 624
date, gift registry 566
footer 611
Edit 593, 596
header template 618
Invitations 588 , 601
Logo 610
Selling restrictions 592
message templates 626
Filterable
Ticker 589
Firewall 127
Website Restrictions 588
PayPal 1859
Free
Facebook 7 , 1217
shipping 1937
Favicon 102, 1500
shipping, price rule 529
FedEx 1993
Frontend Development Workflow 2400
shipping labels 1999
FTP calculations 2149
Feed reader 714
Full
G storefront 559
Global
Germany, PayPal 1860
search 57 , 69
GIF file type 101, 104
[GLOBAL] 111
Gift Card 163, 225
Gmail 607
account 234
Goods & Services Tax 2180
account, multiple 226
Google 818
balance 226
Analytics 818
configure 238
Enhanced Ecommerce 836
create 228
Merchant Center 818
deactivate 226
Reader 714
email template 238
Sitemap 786, 818
expiration date 239
Tag Manager 827
partial deduction 226
Universal Analytics 823, 836
prices 230
Grid
redeem 226
filter 71
refund 226, 1771
layout 72
status 226
Products 151
Gift Card Information 267
sort 70
Gift Card, printed 1657
Grid Settings 1727
Gift Message 1657
Grid, columns 1180
Gift Options 264, 1656
Grid, export data 71
Tax configuration 1662
Grid, Product 743
Gift Receipt 1657
Group price 273
Gift Registry 559
Grouped Product 162, 185
Configure 568
Grouped Products 266
create 562
GST 2180
Customer Account 561
Guest Image
size 379
editor 1196
images 2250
email 617
reindex 2266
Head 1500
Scheduled 2267
http 2116
Import/Export 2237
https 2116
In-Context Checkout, PayPal 1821
Invitation
Include / Exclude Tax 2191
Invoiced
Trigger events 2385
Price 454
cache 2375
Insert image 1197
installation 10
Integrations 2297 K
email 608
L
Inventory
Label
Backorders 312
shipping 2000
Configuration 321
Landing page 772
Manage Stock 312
Landing page, login 1561
Layered navigation
email 609
configuration 757
file types 99
filterable 749
path 99
layout
M
update 1512
Magento
custom 431
account 15
Layout Update 1524
Connect 47
banner 1245
Solutions Partners 47
syntax 1516, 1519
Magento account 16
widget 600 , 1225, 1260
Magento Connect, Install Extension 2105
Left Column 1243
Magento Marketplace 1528 , 2302, 2414
Like button, Facebook 1217
Magnify image 390
Like, Search Type 764
Manage
image 1197
Customers 77
LinkedIn 7
Inventory 312
List, Product 743
Products 76
Listing Sort By, category 419
Stores 2100 , 2110
Load sequence 1524
MAP 282
local.xml 2317
MAP (Minimum Advertised Price) 282
Locale 83
Marketing
Locale, language 2105
menu 54
Login 1585
Reports 2018
Admin 50
Marketplace 2302
demo store 51
markup tag 1199
Landing page 1561
Millennium Generation
Match products by rule 428
Miscellaneous
URL 728 , 1197
HTML 1503
URL, markup tag 722
Misspelled words
Media Gallery 389
redirect 772
Media Storage 1192
Moderate, product reviews 487-488
Media Storage, alternate 2316
Module Manager 2419
Members Only 587 , 591
Money Order 1914
Membership 587
Multi-Address Minimum Order 1648
Menu
Multiple
Catalog 145
Select, input type 454
Customers 1552
Music download 212
Merchandising tools 40
My
InBox 66
Messages N
Admin 66
Name and Address Options 1564
Meta
Name, customer 1564
Information 38 , 782
menu 1202
page 1183
Top 739
Title 782
New
Opt-in 705
Customers 65
Order 1719, 1730
Queries 2085
review 1693
configuration 705
status 1719, 1721
Queue 709
Status workflow 1720
subscribers 77
update 1681
templates 707
Workflow 1711
Outlook 607-608
status, product 157
Payment
Page 1169
actions 1736
create 1183
gateways 47 , 1863
session, customer 2379
methods 47
Translate 2109
options 42
Page Footer 1503
services 47
configuration 1203
merchant solutions 42
Password 127 , 1585
solutions 1861
PDF
Popular Search Terms 773
Pending
Advanced 270
Reviews 487-488
navigation 748 , 754
Price Rule
Events 588
Banner 1247
Persistent
Price Type
image, zoom 390
Fixed 258
images 379
Percentage 258
Images and Videos 247
Bundle 201
Reviews 246
catalog 47
Scheduled Changes 161
Configurable 171-172
Search Engine Optimization 248
HTML 2229
workspace 156
Product Attribute
Group price 273
Best Practices 2482
Grouped 185
Product Attributes 439, 2278
image cache 2375
Advanced Pricing 2291
Image, upload 380
Discount 280
Product in Websites 261
Query
Product List 743
length 764
Product page 32
word count 764
Product Reports 2028
Quick Search 759
Product Reviews 246
attributes 2225
Product Reviews Reports 2020
Quick Tour 23
Product Scope 116
Quote Lifetime 1647
Product Settings 241
Advanced 242
R
Other 243
Rating, product 489
Product Stock Options 321
reCAPTCHA 2344
Product Types 162
Receive payment 1711
Product variations 176
Recently Compared Products 1251
Product View Page, visible on 2229
Recently Viewed Products 486, 1251
Products
Recommendations
menu 54
Search 765
promotion_desecription, variable 634
Record selection 57
promotion_name, variable 633
Redeem
Promotions 492
reward points 577
Redirect
Price Rules 533
misspelled words 772
Provincial Sales Tax 2180
type 803, 807 , 812, 816
PST 2180
Refresh
Private Sales 2032
cache 2374
Products 2028
statistics 2016
Sales 2022
Refund 1781
Reports, menu 2014
offline 1773
Reset, password 1585
online 1773
Resource files, optimize 2402
Products 250
Product 246
Configuratoni 547
Reward Points 577
Create 543
Configure 578
Priority 546
customer group 584
Role
Scripts and Style Sheets 1501
Root
default 764, 766
enable 765
S results 762
email 90
Type, MySQL 764
menu 54
friendly URLs 147
Representative 89
optimization 38
Select
Multiple Addresses 1932
All 74
options 42
Visible 74 rates
Session
Shipping Prices, tax 2175
customer 2379
Shipping, checkout 1685
ID 2379
Shop By 748
Setup Wizard 2412 price rule 508 , 522, 533, 537 , 577
SFTP
promotion 1619
SKU
scenarios 340
Store
use of 172
Store View
controls 70
add 2101
product list 419
Storefront
Automatic 426
Branding 98
Spain, PayPal solutions 1860
CAPTCHA 2339
Spam 705
reCAPTCHA 2344
Special Price 275
class
Surveys 469
VAT 2170
Swatches 395
Class
Swatches, create 397
Gift options 1662
Switch Accounts 21
Default Tax Destination 2147
Synchronization 2317
Digital Goods 2148
Syndicated content 714
Discount Settings 2191-2192
Synonyms 775
Display Settings, configure 2134
search terms 772
General Settings 2131
Syntax
rates
layout update 1519
VAT 2170
System
Rounding 2174
attribute 452
rules 2139
backup 2389
VAT 2170
menu 54
Configuration 2144
Product 2143
Table Rate, shipping 1941
Tax Class, VAT 2185
Tag
Tax Rate
Tag Manager, Google 827
Point of Origin 1931
Tags
Target Path, redirect 803, 807 , 812, 816 Tax Zones and Rates 2158
Template
Tax 47 , 2126, 2139
email reminder 640
Calculation Settings 2191
layout update, widget 1252
Temporary (302) redirect 803, 808 , 812, 816 Two-Factor Authentication 2349
Text U
Area, input type 454
UI Text 2408
editor 1196
Under construction 108
Field, input type 453
United Kingdom, PayPal solutions 1861
Theme 39, 1494-1495
United States
Third-party Unlock
All 74
Image 389
Visible 74
Tier Price 280
Unselect All 76
Export 2263
Unselect Visible 76
Import 2263
rules 542
Tools, system 2371
Up-sells 250
Top Level Category, RSS feed 716
Update Attributes 75
Top navigation 739
UPS 1993
Transactional emails 470
URL 2319
Transactions 1795
VAT Validation
options 147
configure 2170
redirect 794
VIP 587
static 147
Virtual
suffix 249
Gift Card 225
URL, custom Admin 2121
Product 162, 193
Use
Virtual Product 193
Default checkbox 113, 2106
Visit
for Promo Rule Conditions 2229
non-sessioned 2379
in Quick Search 763
sessioned 2379
Use Aggregated Data 64
Vistors
User
Category Rules 554
guides 4
Configuration 558
User guides 4
Web server
V
synchronization 2317
Webinars 4, 7
email 617
[WEBSITE] 111
email reminder 634
Website Restrictions
VAT 2163
Events 588 , 591
Configure 2164
Website,add 2114
VAT ID Validation 2167
Websites workspace
Workspace
product 261
Grid 70
WEEE tax 2149
WYSIWYG Editor
Weight, dimensional 1948
enable 453
Welcome 3
code 724
Z
email 617
Widgets 1249
Wiki 4
Wish List
Search 481
Update 476
configuration 474
Workflow
order 1719
Attribute Use
Consider how attributes are to be used when assigning properties and values. Identify the
attributes that are used as labels for presentation, such as a title or product name, image,
price, and description, and which attributes are used for data entry. Consider how the
attributes are represented on different pages throughout the site, and how they appear on
category pages, product detail pages, category grids, and thumbnail sliders.
Color
Ad-hoc color descriptions can pose a challenge from the standpoint of database operations.
Color names such as “Azure Skies” or “Robin Egg Blue” have great appeal, but might not
return the best results when used as search criteria, or if merchandising requires you to
specify Color_Family:Blue. Take into consideration how colors are represented in search
results and layered navigation, and establish some guidelines for your business needs.
Then, be consistent when assigning color attribute values throughout your catalog.