Product Attributes

Product attributes define the characteristics of products, enabling you to uniquely describe a product.

You can also use product attributes to create facets on category pages to help shoppers narrow their search results. Refer to Attribute Facets for more information.

Attribute Types

Product attributes can either be options, properties, or extras. Refer to the following table for more information about each type:

Options Option attributes include details about a product that shoppers can configure, such as size or color.

When you assign an option to a product, Kibo eCommerce generates a new product variation (or unique SKU). For example, your shirt options may include sizes, colors, and a graphic image. Refer to Product Variations for more information about product variations.

Refer to Option Attributes for more information about creating options and assigning them to products.
Properties Property attributes include inherent details about a product that shoppers cannot configure, such as brand or material.

Properties are useful when viewing reports about your sales. For example, you may offer a 100% cotton shirt of a leading brand, and you want to compare its sales to other shirt materials that you offer.

Refer to Property Attributes for more information about creating properties and assigning them to products.
Extras Extra attributes includes add-on configurations that shoppers configure and usually includes an extra price, such as a monogram or gift wrapping.

Extras are useful when you want to upsell an item or another product. For example, you may offer monogramming on the chest left side or custom team text across the center back. You can also make another product an extra, such as a camera mount that can be sold along with a camera.

When you select another product as an extra, you can select standard products, product variants, and bundle components. You can also customize the label that appears for the product extra in the storefront.

Refer to Extra Attributes for more information about creating extras and assigning them to products.

For example, you sell shirts so you would have the following shirt attributes:

Because all your shirts have one or more of the above product attributes, you need to add all of these possible attributes to Kibo eCommerce in order to account for all of your shirts.

Note:  You assign the attribute's type when creating and configuring product types. For more information about product types, refer to Product Types.

Attribute Input Types and Values

Attributes can have different input types that determine not only how you enter the values for the attribute, but also how shoppers can select attributes in the case of options, or enter values in the case of extras. For example, your shirt size attribute should be a number (2, 4, 6, etc.), while your monogram attribute should be a text string with a character limit you define. Kibo eCommerce supports the following input types:

In addition, you can determine if an attribute value is required for either the shopper configuring the product at checkout or for the Kibo eCommerce user creating a new product definition. Each attribute value created for a predefined list is called a vocabulary value, which lets you create attribute values as localizable content.

Option Attributes

Options include details about a product that shoppers can configure, such as size or color. You can use options in combination with Configurable Products with Options to generate new product variations (or unique SKU). Refer to Product Variations for more information.

In order to fully use option attributes, you must complete the following steps:

  1. Create Option Attributes
    You must first create an option attribute before you can use it for a product.
  2. Add Options to Product Types
    After creating an option attribute, you must then add it to a product type and select all applicable option values for the product type.
  3. Assign Option Values to Products
    After adding an option to a product type, you can then assign option values to products associated with the product type.

Create Option Attributes

You must first create the option attribute before you can add it to product types, and assign option values to products.

When creating attributes, it's especially important to think about all of your products.

To create an option attribute:

  1. Go to System > Schema > Product Attributes
  2. Click Create New Attribute.
  3. In the Attribute Label field, enter the name of the option that shoppers will see.
  4. In the Administration Name field, enter the name that you will see in Admin.
  5. In the Attribute Code field, enter a code for your option.
  6. In the Input Type drop-down menu, select List.
    List is the only input type that supports options. Important:  Once you create and save an attribute, you cannot change its input type.
  7. In the Attribute Type field, select Option:
  8. Select the Data Type, which determines whether the values that shoppers select are text or numbers.
    For example, you're creating a color option, and you want the values to be text for the different colors.
  9. In the Values section, add all possible values for the option. You select the option values that a product can have when you add the option to the product type. You then choose the specific option values that a product has when creating the product. Press Enter after entering each value. You must add the associated value for every list entry, and you can reorder the values after adding them. Note:  You can use the order of the list values as the order of facet values on storefront pages by using the Attribute Definition facet value order. Refer to Attribute Definition Options in the Facet Value Order section of the Facets topic for more information about ordering the facet values according to the list values you specify on the attribute.
  10. Select the Search Options for the option:
    • Available to Storefront Search—This determines whether the option's label or option's values are matched on when shoppers perform a search on the site. For example, you have a color option and one of its values is blue. If you select this checkbox and Search Value, and a shopper performs a search for the term “blue” on your site, the product will be returned in the search results even if the term “blue” is not contained in the product's name or description.
    • Available as Filter and Sort—This determines whether this option is available for filtering, sorting, dynamic category expressions, displayed on category pages, and as a facet in search results. Important:  Having a large number of attributes available for filtering and sorting can reduce the performance of your site. Kibo eCommerce recommends only enabling this checkbox for the attributes that are most likely to be used for these purposes.
  11. Click Save.

Add Options to Product Types

Once you create an option attribute, you can then add it to product types. This allows you to quickly select all applicable options for products belonging to the same product type.

For example, you created a color option, and you want its values to be applied to only shirts. You can add this color option to your shirt product type, so that any shirt products you create will have the same color option values from which you can select.

To add an option to a product type:

  1. Go to System > Schema > Product Types.
  2. Select the applicable product type.
    If you need to create a new product type, refer to Create Product Types for more information.
  3. In the Options section, click Add:
  4. In the Attribute list, select the applicable option: Only attributes that you marked as an option when you created the attribute appear in this list.
  5. In the Values list, select all applicable option values for the product type: The selected values appear in the Selections list.
  6. Decide whether the option is Required by admin.
    If you select this checkbox, when you create a new product and assign it to the product type, you must assign at least one selected option value to the product in order for Kibo eCommerce to consider the product valid for the product type.
  7. Click Done to finish adding the option to the product type:

Assign Option Values to Products

Once you add an option to a product type and selected all applicable option values for the product type, you can then assign the option's values to a product.

For example, you added a color option and selected all applicable color values for the shirt product type. Then when you create a new shirt product, you can assign the applicable color values to that specific shirt product.

Note:  When you assign option values to a product, you create a product variant for each assigned option value. Refer to Product Variations for more information.

To assign an option value to a product:

  1. Go to Main > Catalog > Products.
  2. Select the applicable product.
    If you need to create a new product, refer to Create Products for more information.
  3. (If applicable) If you haven't already done so, assign the applicable Product Type to the product:
  4. (If applicable) If you haven't already done so, set Product Usage to Configurable Product with Options.
    You must set the product usage to configurable product with options in order to assign option values to the product.
  5. In the Options section, set the Pricing Mode for the product variants.
    The pricing mode controls how you specify the price and weight for each product variant. Refer to Product Variant Pricing and Weight for more information.
  6. Click Select Values.
    The Edit Variants window appears.
  7. In the Edit Variants window, select Update Options: The Child Products window appears.
  8. In the Child Products window, select all applicable option values that you want to assign to the product and click Save: When you select an option value, Kibo eCommerce automatically creates a product variant for that option value. Refer to Product Variations for more information.
  9. Back in the Edit Variants window, complete the following actions:
    1. Enable each product variant
    2. (Optional) Specify a unique Product Code.
      If you choose to not specify a unique product code for the variant, Kibo eCommerce automatically creates a product code based on the base product's code. Refer to Product Variant Codes for more information.
    3. Depending on the Pricing Mode you previously selected, specify the price and weight of each product variant.
    4. Click Save.
  10. Click Save in the product editor to save your changes.

Property Attributes

Properties include inherent details about a product that shoppers cannot configure, such as brand or material. You can use properties to provide more details about a product to shoppers.

In order to fully use property attributes, you must complete the following steps:

  1. Create Property Attributes
    You must first create a property attribute before you can use it for a product.
  2. Add Properties to Product Types
    After creating a property attribute, you must then add it to a product type and select all applicable property values for the product type.
  3. Assign Property Values to Products
    After adding a property to a product type, you can then assign property values to products associated with the product type.

Create Property Attributes

You must first create the property attribute before you can add it to product types, and assign property values to products.

When creating attributes, it's especially important to think about all of your products.

To create a property attribute:

  1. Go to System > Schema > Product Attributes.
  2. Click Create New Attribute.
  3. In the Attribute Label field, enter the name of the property that shoppers will see.
  4. In the Administration Name field, enter the name that you will see in Admin.
  5. In the Attribute Code field, enter a code for your property.
  6. Use the Input Type drop-down menu to select how the property stores its values.
    For example, you're creating a property for brand, and you want the property to store a list of various brand names. Important:  Once you create and save an attribute, you cannot change its input type.
  7. In the Attribute Type field, select Property: Depending on the input type you selected, this field either appears as a list of checkboxes or a drop-down menu. For the list input type, you can select multiple attribute types - ensure that you at least select Property.
  8. (If applicable) In the Data Type field, select the data type of the property's values.
    For example, you're creating a brand property, and you want the values to be text for the brand names.
  9. (Text box only) In the Min char/val and Max char/val fields, enter the minimum and maximum amount of characters allowed in the property's value as applicable. For example, you're creating an associated product property and you want to restrict the minimum and maximum amount of characters the property's value can have.
  10. (Text box only) In the Input Validation field, enter any RegEx which you want to use to validate the characters in the property's value. For example, you're creating a manufacturing code property and you want to restrict the allowed characters to only letters, numbers, underscores, white space characters, and common punctuation marks. You can enter the following RegEx to accomplish this: ^[a-zA-Z0-9_\s\.\,\!\&\?]*$.
  11. (Text area only) In the Max char. field, enter the maximum amount of characters to which you want to limit the property's text box value.
    For example, you're creating an address of origin property and you want to limit the text box value to a maximum of 250 characters.
  12. (Date only) In the Valid Date Range field, enter the start and end dates to restrict the dates that the property's value can have.
  13. (List only) In the Values section, add all possible values for the property. You select the property values that a product can have when you add the property to the product type. You then choose the specific property values that a product has when creating the product. Press Enter after entering each value. You must add the associated value for every list entry. You can reorder the values after adding them. Note:  You can use the order of the list values as the order of facet values on storefront pages by using the Attribute Definition facet value order. Refer to Attribute Definition Options in the Facet Value Order section of the Facets topic for more information about ordering the facet values according to the list values you specify on the attribute.
  14. Select the Search Options for the property:
    • Available to Storefront Search—This determines whether the property's label or property's values are matched on when shoppers perform a search on the site. For example, you have a brand property and one of its values is Surly. If you select this checkbox and Search Value, and a shopper performs a search for the term "surly" on your site, the product will be returned in the search results even if the term “surly” is not contained in the product's name or description.
    • Available as Filter and Sort—This determines whether this property is available for filtering, sorting, dynamic category expressions, displayed on category pages, and as a facet in search results. Important:  Having a large number of attributes available for filtering and sorting can reduce the performance of your site. Kibo eCommerce recommends only enabling this checkbox for the attributes that are most likely to be used for these purposes.
  15. Click Save.

Add Properties to Product Types

Once you create a property attribute, you can then add it to product types. This allows you to quickly select all applicable properties for products belonging to the same product type.

For example, you created a shirt brand property, and you want its values to be applied to only shirts. You can add this brand property to your shirt product type, so that any shirt products you create will have the same brand values from which you can select.

To add a property to a product type:

  1. Go to System > Schema > Product Types.
  2. Select the applicable product type.
    If you need to create a new product type, refer to Create Product Types for more information.
  3. In the Properties section, click Add:
  4. In the Attribute list, select the applicable property: Only attributes that you marked as a property when you created the attribute appear in this list.
  5. In the Values list, select all applicable property values for the product type: The selected values appear in the Selections list.
  6. Decide whether the property is Required by admin.
    If you select this checkbox, when you create a new product and assign it to the product type, you must assign at least one selected property value to the product in order for Kibo eCommerce to consider the product valid for the product type.
  7. Decide whether to Allow Multi Select for the property.
    If you select this checkbox, you can select multiple values for the property when creating a product.
  8. Select a Display Group for the property.
    This drop-down menu controls where the property and its value are available to be displayed. You can select either Storefront Details and Listings, Storefront Details, or Admin Only. Refer to Display Group for more information.
  9. Decide whether the property is Hidden from Shopper.
    If you select this checkbox, the property and its values will be hidden from the shopper. This is useful if you still want the property and its values to be available to the storefront, but you want it to be hidden from shoppers. For example, you create a property to store unique codes for products, and you want to perform some logic on this code, but you don't want the code to appear to shoppers.
  10. Click Done to finish adding the property to the product type:

Assign Property Values to Products

Once you add a property to a product type and selected all applicable property values for the product type, you can then assign the property's values to a product.

For example, you added a brand property and selected all applicable brand values for the shirt product type. Then when you create a new shirt product, you can assign the applicable brand value to that specific shirt product.

To assign a property value to a product:

  1. Go to Main > Catalog > Products.
  2. Select the applicable product.
    If you need to create a new product, refer to Create Products for more information.
  3. (If applicable) If you haven't already done so, assign the applicable Product Type to the product:
  4. (If applicable) If you haven't already done so, assign the applicable Product Usage to the product.
  5. Under the Properties section, for each applicable property, select the applicable property value for the product: Depending on the configuration options you selected for the applicable product type, Kibo eCommerce requires you to select at least one property value, and you can select multiple property values. Refer to the steps that discuss the Required by admin and Allow Multi Select settings in the Add Properties to Product Types section.
  6. Click Save in the product editor to save your changes.

Extra Attributes

Extra attributes include add-on configurations that a shopper configures and usually includes an extra price, such as a monogram or gift wrapping.

You can also make another product an extra, known as a product extra, such as a camera mount that can be sold along with a camera.

In order to fully use extra attributes, you must complete the following steps:

  1. Create Extra Attributes
    You must first create an extra attribute before you can use it for a product.
  2. Add Extras to Product Types
    After creating an extra attribute, you must then add it to a product type and select all applicable extra values for the product type.
  3. Assign Extra Values to Products
    After adding an extra to a product type, you can then assign extra values to products associated with the product type.

Create Extra Attributes

You must first create the extra attribute before you can add it to product types, and assign extra values to products.

When creating attributes, it's especially important to think about all of your products.

To create an extra attribute:

  1. Go to System > Schema > Product Attributes.
  2. Click Create New Attribute.
  3. In the Attribute Label field, enter the name of the extra that shoppers will see.
  4. In the Administration Name field, enter the name that you will see in Admin.
  5. In the Attribute Code field, enter a code for your extra.
  6. Use the Input Type drop-down menu to select how the extra stores its values.
    For example, you're creating an extra for monogramming, and you want the extra to store text inside of a box/field. Important:  Once you create and save an attribute, you cannot change its input type.
  7. In the Attribute Type field, select Extra: Depending on the input type you selected, this field either appears as a list of checkboxes or a drop-down menu. For the list input type, you can select multiple attribute types - ensure that you at least select Extra.
  8. (If applicable) In the Data Type field, select the data type of the extra's values.
    For example, you're creating a monogramming extra, and you want the values to be text for the monogram text shoppers will enter.
    For the list input type, you can select either Text, Number, or Product.
  9. (Text box only) In the Min char/val and Max char/val fields, enter the minimum and maximum amount of characters allowed in the extra's value as applicable.
  10. (Text box only) In the Input Validation field, enter any RegEx which you want to use to validate the characters in the extra's value. For example, you want to restrict the allowed characters to only letters, numbers, underscores, whitespace characters, and common punctuation marks. You can enter the following RegEx to accomplish this: ^[a-zA-Z0-9_\s\.\,\!\&\?]*$.
  11. (Text area only) In the Max char. field, enter the maximum amount of characters to which you want to limit the extra's text box value.
    For example, you're creating a gift message extra and you want to limit the text box value to a maximum of 250 characters.
  12. (Date only) In the Valid Date Range field, enter the start and end dates to restrict the dates that the extra's value can have.
  13. (List only) In the Values section, add all possible values for the extra. You can perform the following actions depending on the data type you selected:
    • Product Data Type — Select all applicable products to add to the list: You can only add existing products that are associated with the same master catalog with which the extra attribute is associated. You can customize the label that appears for the product extra in your storefront using the Storefront Label field; otherwise the product's catalog name will appear in your storefront.
    • Number or Text Data Type — Enter all applicable values to the list: Press Enter after typing each value to add it to the list.
    For either value data type, you can reorder the values after adding them.
    Note:  You can use the order of the list values as the order of facet values on storefront pages by using the Attribute Definition facet value order. Refer to Attribute Definition Options in the Facet Value Order section of the Facets topic for more information about ordering the facet values according to the list values you specify on the attribute.
  14. Select the Search Options for the extra:
    • Available to Storefront Search—This determines whether the extra's label or extra's values are matched on when shoppers perform a search on the site. For example, you have a gift wrapping extra and one of its values is Yes. If you select this checkbox and Search Label, and a shopper performs a search for the term "gift wrapping" on your site, the product will be returned in the search results even if the term "gift wrapping" is not contained in the product's name or description.
    • Available as Filter and Sort—This determines whether this extra is available for filtering, sorting, dynamic category expressions, displayed on category pages, and as a facet in search results. Important:  Having a large number of attributes available for filtering and sorting can reduce the performance of your site. Kibo eCommerce recommends only enabling this checkbox for the attributes that are most likely to be used for these purposes.
  15. Click Save.

Add Extras to Product Types

Once you create an extra attribute, you can then add it to product types. This allows you to quickly select all applicable extras for products belonging to the same product type.

For example, you created a monogramming extra, and you want its values to be applied to only shirts. You can add this monogramming extra to your shirt product type, so that any shirt products you create will have the same extra values from which you can select.

To add an extra to a product type:

  1. Go to System > Schema > Product Types.
  2. Select the applicable product type.
    If you need to create a new product type, refer to Create Product Types for more information.
  3. In the Extras section, click Add:
  4. In the Attribute list, select the applicable extra: Only attributes that you marked as an extra when you created the attribute appear in this list.
  5. In the Values list, select all applicable property values for the product type: The selected values appear in the Selections list: You can reorder the values in the Selections list. Important:  The order of the extra values in the Selections list is the order that Kibo eCommerce displays them on your storefront, for example:
  6. Decide whether the extra is Required by admin.
    If you select this checkbox, when you create a new product and assign it to the product type, you must assign at least one selected extra value to the product in order for Kibo eCommerce to consider the product valid for the product type.
  7. Decide whether to Allow Multi Select for the extra.
    If you select this checkbox, you can select multiple values for the extra when creating a product.
  8. Click Done to finish adding the extra to the product type:

Assign Extra Values to Products

Once you add an extra to a product type and selected all applicable extra values for the product type, you can then assign the extra's values to a product.

For example, you added a monogram text color extra and selected all applicable monogram text color values for the shirt product type. Then when you create a new shirt product, you can assign all applicable monogram text color value to that specific shirt product.

To assign an extra value to a product:

  1. Go to Main > Catalog > Products.
  2. Select the applicable product.
    If you need to create a new product, refer to Create Products for more information.
  3. (If applicable) If you haven't already done so, assign the applicable Product Type to the product:
  4. (If applicable) If you haven't already done so, assign the applicable Product Usage to the product.
  5. Under the Extras section, select the applicable extra for the product:
  6. For each selected extra, select all applicable extra values to assign to the product:
  7. For each selected extra value, specify the following:
    1. Price — The price a shopper must pay for the extra value.
    2. Quantity — (Product data type only) The quantity of the product extra that a shopper must purchase. If you track inventory for the product, keep this quantity in mind when tracking inventory quantities for the product. Refer to Inventory Management for more information.
    3. (If applicableWeight — The weight of the extra value.
    4. Defaulted — If selected, Kibo eCommerce automatically selects the extra value on the product details page in your storefront.
  8. Decide whether the following settings are applicable for the extra:
    • Required by Shopper — If selected, shoppers must select a value for the extra in order to add the product to their cart.
    • Allow Multi Select — (List input type only) If selected, shoppers can select multiple values for the extra.
  9. Click Save in the product editor to save your changes.