Product Attribute Reference CHAPTER 69: Data Transfer
Product Attribute Reference
The following table lists the attributes from a typical product export, in the default order in which they appear. Each attribute is represented in the CSV file as a column, and product records are represented by rows. Columns that begin with an underscore contain service data such as properties or option values for complex data.
The installation used to export this data has the sample data installed, and has two websites and several store views. Although this list includes all columns that are typically exported, the sku is the only required value. To import data, you can include only the columns with changes. The sku should be the first column, but the order of the rest of the attributes doesn’t matter.
Simple Product CSV File Structure
ATTRIBUTE DESCRIPTION
sku
(Required) The Stock-Keeping Unit is a unique, alphanumeric identifier that is used to track inventory. A
SKU can be up to 64 characters in length. For example: sku123
A SKU longer than 64 characters will cause import to fail.
store_view_code attribute_set_code product_type
Identifies the specific store view(s) where the product is available. If blank, the product is available at the default store view. For example: storeview1 english,spanish
Assigns the product to a specific attribute set or product template, according to product type. Once the product is created, the attribute set cannot be changed. For example: default
Indicates the type of product.Values include:
886 Magento Community Edition 2.0 User Guide
CHAPTER 69: Data Transfer Product Attribute Reference
Simple Product CSV File Structure (cont.)
ATTRIBUTE DESCRIPTION
simple grouped configurable virtual bundle
Tangible items that are generally sold as single units or in fixed quantities.
A group of separate products that is sold as a set.
A product with multiple options that the customer must select before making a purchase.
Inventory can be managed for each set of variations because they represent a separate product with a distinct SKU. For example, a combination of color and size for a configurable product is associated with a specific SKU in the catalog.
A non-tangible product that does not require shipping and is not kept in inventory. Examples include services, memberships, and subscriptions.
A customizable product set of simple products that are sold together.
categories
Indicates each category that is assigned to the product.
Separate categories and subcategories with a forward slash. To indicate multiple category paths, separate each path with a pipe “|” symbol. For example:
Default Category/Gear|Default Category/Gear/Bags
Magento Community Edition 2.0 User Guide 887
Product Attribute Reference CHAPTER 69: Data Transfer
Simple Product CSV File Structure (cont.)
ATTRIBUTE DESCRIPTION
product_websites
The
website code
of each website where the product is available. A single product can be assigned to multiple websites, or limited to one. If specifying multiple websites, separate each with a comma and without a space. For example: base base,website2 name description short_description weight product_online
The product name appears in all product listings, and is the name that customers use to identify the product.
The product description provides detailed information about the product, and might include simple HTML tags.
The use of the short product description depends on the theme. It might appear in product listings and is sometimes used in RSS feed listings sent to shopping sites.
The weight of the individual product. The actual product weight is determined by the carrier at the time of shipment.
Determines if the product is available for sale in the store. Values include:
1 (Yes) The product is immediately available for sale in your store.
0 (or blank) (No) The product is not included in online catalog listings.
tax_class_name visibility
The name of the tax class that is associated with this product.
Determines if the product is visible in the catalog, and made available for search. Values include:
888 Magento Community Edition 2.0 User Guide
CHAPTER 69: Data Transfer Product Attribute Reference
Simple Product CSV File Structure (cont.)
ATTRIBUTE DESCRIPTION
Not Visible
Individually
Catalog
Search
Catalog, Search
The product is not included in product listings, although it might be available as a variation of another product.
The product appears in all catalog listings.
The product is available for search operations.
The product is included in catalog listings and is also available for search.
price special_price special_price_from_date special_price_to_date url_key meta_title meta_keywords
The price that the product is offered for sale in your store.
The discounted price of the product during the specified date range.
The beginning date of the time period when the special price is in effect.
The last date of the time period when the special price is in effect.
The part of the URL that identifies the product. The default value is based on the product name. For example: product-name
The meta title appears in the title bar and tab of the browser and search results lists. The meta title should be unique to the product, incorporate high-value keywords, and be less than 70 characters in length.
Meta keywords are visible only to search engines, and are ignored by some search engines. Choose high-value keywords, separated by a comma. For example: keyword1,keyword2,keyword3.
Magento Community Edition 2.0 User Guide 889
Product Attribute Reference CHAPTER 69: Data Transfer
Simple Product CSV File Structure (cont.)
ATTRIBUTE DESCRIPTION
meta_description
Meta descriptions provide a brief overview of the product for search results listings. Ideally, a meta description should be between 150-160 characters in length, although the field accepts up to 255 characters.
base_image base_image_label small_image small_image_label thumbnail_image thumbnail_image_label created_at updated_at
The relative path for the main image on the product page.
Magento stores files internally in an alphabetical folder structure.You can see the exact location of each image in the exported data. For example:
/sample_data/m/b/mb01-blue-0.jpg
To upload a new image or write over an existing image, enter the file name, preceded by a forward slash. For example: /image.jpg
The label that is associated with the base image.
The file name of the small image that is used on catalog pages, preceded by a forward slash. For example:
/image.jpg
The label associated with the small image. For example:
Small Image 1, Small Image 2
The file names of any thumbnail image to appear in the gallery on the product page, preceded by a forward slash.
For example:
/image.jpg
The label associated with any thumbnail images. For example:
Thumbnail 1, Thumbnail 2
Indicates the date when the product was created. The date is automatically generated when the product is created, but can be edited later.
Indicates the date when the product was last updated.
890 Magento Community Edition 2.0 User Guide
CHAPTER 69: Data Transfer Product Attribute Reference
Simple Product CSV File Structure (cont.)
ATTRIBUTE DESCRIPTION
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 display_product_options_in map_price msrp_price map_enabled
Specifies the “to” date for new product listings, and determines if the product is featured as a new product.
If the product has multiple options, determines where they appear on the product page. Values include:
Product Info Column
Block after Info Column
The minimum advertised price of the product. (Appears only if MAP is enabled.)
The manufacturer’s suggested retail price for the product.
(Appears only if MAP is enabled.)
Determines if Minimum Advertised Price is enabled in the configuration. Values include:
1 (Yes) MAP is enabled.
0 (or blank) (No) MAP is not enabled.
gift_message_available custom_design custom_design_from
Determines if a gift message can be included with the product purchase. Values include:
1 (Yes) The option to include a gift message is presented to the customer.
0 (or blank) (No) The option to include a gift message is not presented to the customer.
Lists the available themes that can be applied to the product page.
Specifies the beginning date when the selected theme is applied to the product page.
Magento Community Edition 2.0 User Guide 891
Product Attribute Reference CHAPTER 69: Data Transfer
Simple Product CSV File Structure (cont.)
ATTRIBUTE DESCRIPTION
custom_design_to
Specifies the end date when the selected theme is applied to the product page.
custom_layout_update page_layout
Additional XML code that is applied as a layout update to the product page.
Determines the page layout of the product page. Values include:
No layout updates No change is made to the page layout.
1 column Applies a one- column layout to the product page.
2 columns with left bar
Applies a two-column layout with a left sidebar to the product page.
2 columns with right bar
Applies a two-column layout with a right sidebar to the product page.
3 columns empty
Applies a three-column layout to the product page.
Applies a blank layout to the product page.
product_options_container msrp_display_actual_price_ type
If the product has multiple options, determines where they appear on the product page. Values include:
Product Info Column
Block after Info Column
Determines where the actual price of a product is visible to the customer.Values include:
892 Magento Community Edition 2.0 User Guide
CHAPTER 69: Data Transfer Product Attribute Reference
Simple Product CSV File Structure (cont.)
ATTRIBUTE DESCRIPTION
In Cart
Before Order
Confirmation
On Gesture
Displays the actual product price in the shopping cart.
Displays the actual product price at the end of the checkout process, just before the order is confirmed.
Displays the actual product price in a popup when the customer clicks the “Click for price” or
“What’s this?” link.
country_of_manufacture additional_attributes qty out_of_stock_qty use_config_min_qty
Identifies the country where the product was manufactured.
Additional attributes created for the product. For example: has_options=0,required_options=0 color=Black,has_options=0,required_options=0,size_ general=XS
The quantity of the product that is currently in stock.
The stock level that determines the product to be out of stock.
Determines if the default value from the configuration is used, and corresponds to the Use Config Settings checkbox. Values include:
1 (Yes) The default configuration setting is used for the value of this attribute.
0 (or blank) (No) The default configuration can be overridden for the value of this attribute.
is_qty_decimal
Determines if the qty attribute has a decimal value.
Values include:
Magento Community Edition 2.0 User Guide 893
Product Attribute Reference CHAPTER 69: Data Transfer
Simple Product CSV File Structure (cont.)
ATTRIBUTE DESCRIPTION
1 (Yes) The value of the qty attribute is a decimal value.
0 (or blank) (No) The value of the qty attribute is a whole number (integer).
allow_backorders use_config_backorders min_cart_qty use_config_min_sale_qty max_cart_qty use_config_max_sale_qty
Determines if your store allows backorders, and how they are managed.
Determines if the default configuration setting for backorders is used, and corresponds to the state of the
Use Config Settings checkbox. Values include:
1 (Yes) The default configuration setting is used for the value of this attribute.
0 (or blank) (No) The default configuration can be overridden for the value of this attribute.
Specifies the minimum quantity of the item that can be purchased in a single order.
Determines if the default configuration setting for minimum quantity is used, and corresponds to the state of the Use Config Settings checkbox.. Values include:
1 (Yes) The default configuration setting is used for the value of this attribute.
0 (or blank) (No) The default configuration can be overridden for the value of this attribute.
Specifies the maxinum quantity of the product that can be purchased in a single order.
Determines if the default configuration setting for maximum quantity is used, and corresponds to the state of the Use Config Settings checkbox.. Values include:
894 Magento Community Edition 2.0 User Guide
CHAPTER 69: Data Transfer Product Attribute Reference
Simple Product CSV File Structure (cont.)
ATTRIBUTE DESCRIPTION
1 (Yes) The default configuration setting is used for the value of this attribute.
0 (or blank) (No) The default configuration can be overridden for the value of this attribute.
is_in_stock notify_on_stock_below
Indicates if the product is in stock.
Specifies the stock level that triggers an “out of stock” notification.
use_config_notify_stock_qty
Determines if the default configuration setting is used to trigger stock level notification, and corresponds to the state of the Use Config Settings checkbox. Values include:
1 (Yes) The default configuration setting is used for the value of this attribute.
0 (or blank) (No) The default configuration can be overridden for the value of this attribute.
manage_stock use_config_manage_stock
Determines if inventory control is used to manage the product. Values include:
1 (Yes) Activates full inventory control to manage stock levels of the product.
0 (or blank) (No) The system does not keep track of the number of items that are currently in stock.
Determines if the default configuration setting for managing stock is used, and corresponds to the state of the Use Config Settings checkbox. Values include:
1 (Yes) The default configuration setting is used for the value of this attribute.
0 (or blank) (No) The default configuration can be overridden for the value of this attribute.
Magento Community Edition 2.0 User Guide 895
Product Attribute Reference CHAPTER 69: Data Transfer
Simple Product CSV File Structure (cont.)
ATTRIBUTE DESCRIPTION
use_config_qty_increments
Determines if the default configuration setting for quantity increments is used, and corresponds to the state of the Use Config Settings checkbox.. Values include:
1 (Yes) The default configuration setting is used for the value of this attribute.
0 (or blank) (No) The default configuration can be overridden for the value of this attribute.
qty_increments use_config_enable_qty_inc
Determines if the product is sold in quantity increments. Options include: Yes / No
Determines if the default configuration setting to enable quantity increments is used, and corresponds to the state of the Use Config Settings checkbox. Values include:
1 (Yes) The default configuration setting is used for the value of this attribute.
0 (or blank) (No) The default configuration can be overridden for the value of this attribute.
enable_qty_increments is_decimal_divided website_id related_skus crosssell_skus
Determines if quantity increments are enabled for the product.
Determines if parts of the product can be shipped separately. Options include: Yes / No
For installations with multiple websites, identifies a specific website where the product is available. If blank, the product is available in all websites.
Lists the sku of each product that has been identified as a
Related Product . For example:
24-WG080,24-UG03,24-UG01,24-UG02
Lists the sku of each product that has been identified as a
Cross-sell .
896 Magento Community Edition 2.0 User Guide
CHAPTER 69: Data Transfer Product Attribute Reference
Simple Product CSV File Structure (cont.)
ATTRIBUTE
upsell_skus
DESCRIPTION
Lists the sku of each product that has been identified as an
Upsell .
additional_images
The file names of any additional image to be associated with the product, preceded by a forward slash. For example:
/image.jpg
additional_image_labels custom_options
The labels associated with any additional images. For example:
Label 1, Label 2
For example: name=Color,type=drop_down,required=1,price=,price_ type=fixed,sku=,option_ title=Black|name=Color,type=drop_ down,required=1,price=,price_type=fixed,sku=,option_ title=White
SERVICE DATA FOR PRODUCT VARIATIONS
_super_products_sku
The generated SKU for a configurable product variation.
For example: WB03-XS-Green
Applies to:
Configurable Products
_super_attribute_code
The attribute code of a configurable product variation. For example: color
Applies to:
Configurable Products
_super_attribute_option
The value of a configurable product variation. For example: green
Applies to:
Configurable Products
_super_attribute_price_corr
A price adjustment that is associated with a configurable product variation.
Magento Community Edition 2.0 User Guide 897
Product Attribute Reference CHAPTER 69: Data Transfer
Simple Product CSV File Structure (cont.)
ATTRIBUTE DESCRIPTION
Applies to:
Configurable Products
_associated_sku
_associated_default_qty
The SKU of a product that is associated with a grouped product.
Applies to:
Grouped Products
Bundle Products
Determines the quantity of the associated product that is included. Applies to:
Configurable Products
Grouped Products
Bundle Products
_associated_position
Determines the position of the associated product when listed with other associated products. Applies to:
Configurable Products
Grouped Products
Bundle Products
898 Magento Community Edition 2.0 User Guide
CHAPTER 69: Data Transfer Product Attribute Reference
Complex Data
The term complex data
1 refers to the data that is associated with multiple product options.
The following product types use data that originates from separate products to create product variations and multiple options.
l
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.
Exported Configurable Product Data
Complex Data Attributes
ATTRIBUTE DESCRIPTION
CONFIGURABLE PRODUCTS
configurab le_ variation_ labels
Labels that identify product variations. For example:
Choose Color:
Choose Size: configurab le_ variations
Describes the values associated with a product variation. For example: sku=sku-red xs,color=red,size=xs,price=10.99,display=1,image=/pub/media/import/image1.
png|sku=sku-redm,color=red,size=m,price=20.88,display=1,image=/pub/media/import/image2.p
ng
1Data that is associated with multiple product options.
Magento Community Edition 2.0 User Guide 899
Product Attribute Reference CHAPTER 69: Data Transfer
Complex Data Attributes (cont.)
ATTRIBUTE DESCRIPTION
GROUPED PRODUCTS
associated_ skus
Identifies the SKUs of the individual products that make up the group.
BUNDLE PRODUCTS
bundle_ price_type
Determines if the price of a bundle item is fixed or dynamic.
bundle_sku_ type
Determines if each item is assigned a variable, dynamic SKU, or if a fixed SKU is used for the bundle. Options include: Fixed / Dynamic.
bundle_ weight_type
Determines if the weight of a bundle item is variable or fixed.
bundle_ values
Describes teach value associated with a bundle option. For example: name=Bundle Option One,type=dropdown; required=1, sku=skuoption2,price=10, price_type=fixed
900 Magento Community Edition 2.0 User Guide
CHAPTER 69: Data Transfer Product Attribute Reference
Advanced Pricing
Advanced Price Import/Export allows you to quickly update pricing information for product groups and tier prices. The process to
import
and
export
advanced price data is the same as any other entity type. The sample CSV file contains tier and group prices for each product type that supports advanced pricing. Making changes to advanced pricing does not affect the rest of the product record.
Advanced Pricing Attributes
ATTRIBUTE
Advanced Price Sample File
DESCRIPTION
sku
(Required) The Stock-Keeping Unit is a unique, alphanumeric identifier that is used to track inventory. A SKU can be up to 64 characters in length. For example: sku123
A SKU longer than 64 characters will cause import to fail.
tier_price_website
The
website code
identifies each website where tier pricing is available. For example: website1
All Websites [USD] tier_price_ customer_group
Identifies the
customers groups
where tier pricing is available. For example:
ALL GROUPS
NOT LOGGED IN
General
Wholesale
Retailer tier_price_qty tier_price
The quantity of the product that must be ordered to receive the tier price discount.
The discounted tier price of the product. For
bundle
products, tier price is calculated as a percentage.
Magento Community Edition 2.0 User Guide 901
Product Attribute Reference CHAPTER 69: Data Transfer
Advanced Pricing Attributes (cont.)
ATTRIBUTE DESCRIPTION
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_group group_price
Identifies the
customers groups
where group pricing is available. For example:
NOT LOGGED IN
General
Wholesale
Retailer
The discounted group price of the product. For
bundle
products, group price is calculated as a percentage.
902 Magento Community Edition 2.0 User Guide
