Magento Open Source 2.3.x

Product Attributes

Product attributeA characteristic or property of a product; anything that describes a product. Examples of product attributes include color, size, weight, and price. properties determine how an attribute can be used in the catalog, its appearance and behavior in the store, and in data transfer operations. The properties and labels associated with each attribute determine how it can be used, and its presentation in the store.

  • Properties

    The Properties section includes both basic and advanced attribute properties.

    Labels

    The label identifies an attribute in the Admin and also in the storefront of each store view. If your store is available in multiple languages, you can enter a different translated label for each language.

    Storefront Properties

    The Storefront Properties determine how an attribute can be used in your store, its appearance, and behavior. You can specify if attributes are available for search, layered navigation, product comparisons, price rules, and sorting. For text attributes, you can enable the WYSIWYG editor, and determine if HTML tags can be used to format the values.

To learn how to use attributes while creating a product, see: Product Attributes.


Product Attributes Page
  • Property Descriptions

    Property

    Description

    Attribute Properties

    Default Label

    The label that identifies the attribute during data entry.

    Catalog Input Type for Store Owner

    Determines the data type and input control that is used to manage the product from the store Admin. Options include:

    Text Field

    A single line input field for text.

    Text Area

    A multiple-line input field that can display paragraphs of text formatted with HTML.

    Text Editor

    Adds a fully-functioning text editor at the attribute location.

    Date

    An input field for date values. The date can be typed directly into the field, or selected from a list or calendar.

    Yes/No

    A drop-down list with predefined options of “Yes” and “No.”

    Multiple Select

    A drop-down list of options that allows multiple selections. To select more than one option, hold down the Ctrl key and click each item.

    Dropdown

    A drop-down list of options that allows only one selection.

    Price

    An input type that can be used to create price fields in addition to the predefined attributes: Price, Special Price, Tier Price and Cost.

    Media Image

    An additional image that can be included in the attribute set of a product.

    Fixed Product Tax

    An input type that gives you the ability to 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.

    Text Swatch

    A text-based representation of a configurable product option that is frequently used for size. Text swatches can also include hexadecimal color values.

    Values Required

    To require that a value to be entered in this field before the record can be saved, set Values Required to “Yes.” Options include: Yes / No

     

    Advanced Attribute Properties

    Attribute Code

    (Required) A unique identifier for internal use. The Attribute Code must begin with a letter, but can include a combination of lowercase letters (a-z) and numbers (0-9). The code must be less than thirty characters in length and cannot include any special characters or spaces, although an underscore (_) can be used to indicate a space.

    Scope

    Limits the use of an attribute to a specific store view or website. Options include:
    Store View

    Website

    Global

    Default Value

    Assigns a starting value to the attribute to help during data entry. To assign a default value for Multiple Select or Dropdown input types, see: Creating Product Attributes.

    A default value cannot be set for Multiple Select, Dropdown, or Fixed Product Tax input types.

    Unique Value

    Requires the attribute value to be different from all other values entered in the same attribute, within the context of the scope setting. Unique value should be enabled for any attribute that is used as an ID number. For example, because SKU is used to identify products throughout the hierarchy, it has a unique value with a global scope. Options: Yes / No

    Input Validation for Store Owner

    Performs a validation check of the data entered in the field, based on the following options:

    None

    Decimal Number

    Integer Number

    Email

    URL

    Letters

    Letters (a-z, A-Z) or Numbers (0-9)

    Add to Column Options

    Determines if the column appears in the product grid. Options: Yes / No

    Use in Filter Options

    Determines if the attribute is used as a filter control at the top of columns in the grid. Options: Yes / No

  • Storefront Property Descriptions

    Property

    Description

    Use in Search

    Select “Yes” if you want people to be able to search the catalog based on the value of this attribute. Options include: Yes / No

    The following attributes appear when Search is enabled:

    Search Weight

    To weight the search results, set Search Weight to a number from 1 to 10.

    Visible in Advanced Search

    Gives shoppers the ability to enter search criteria through a form. Options include: Yes / No

    Using too many attributes can slow down search.

    Comparable on Storefront

    Select “Yes” to include this attribute as a row in the Compare Products report. Options include: Yes / No

    Use In Layered Navigation

    (Dropdown, Multiple Select and Price input types only) Includes the attribute as a filter in the “Shop By” section of layered navigation. Options include:

    No

    The attribute is not available to be used as a filter in layered navigation.

    Filterable (with results)

    Layered navigation includes only those filters for which matching products can be found. Any attribute value that already applies to all products shown in the list does not appear as an available filter. Attribute values with a count of zero (0) product matches are also omitted from the list of available filters.

    The filtered list of products includes only those that match the filter. The products list is updated only if the selected filter(s) change what is currently shown.

    Filterable (no results)

    Layered navigation includes filters for all available attribute values and their product counts, including those with zero (0) product matches. If the attribute value is a swatch, the value appears as a filter, but is crossed out.

    Use In Search Results Layered Navigation

    To include the attribute in the layered navigation for search results, select “Yes.” Options include: Yes / No

    Position

    Determines the position of the attribute in layered navigation in relation to other filterable attributes.

    The Position field will be grayed out by default. You must save the attribute before you can modify this setting.

    Use for Promo Rule Conditions

    To make the attribute available for use in price rules, select “Yes.” Options include: Yes / No

    Allow HTML Tags on Storefront

    (Text Field and Text Area input types only) To be able to format the attribute value with HTML tags, select “Yes.” Options include: Yes / No

    Visible on Catalog Pages on Storefront

    (Simple and virtual products only) To include the attribute on the Additional Information tab of the product page, select “Yes.” Options include: Yes / No

    Used in Product Listing

    Depends on the theme. To include the attribute in product summaries that appear in catalog listings, select “Yes.”

    Used for Sorting in Product Listing

    Depending on theme, includes the attribute as a “Sort  By” option for catalog listings. Options: Yes / No