SKU Select Attributes

This guide explains how to configure SKU attributes in your product catalog to support the SKU Select feature. Learn how to enable SKU-level faceting and filtering, define a default SKU for a product, and display Hero SKU pricing in API responses.

Prerequisites

To use SKU Select, you must include SKU data in your product catalog. Ensure your catalog is set up before applying the changes described in this guide.

Faceting and filtering SKU attributes

Use reserved SKU attributes

Reserved attributes are predefined by Bloomreach. You must use them with the exact naming conventions shown in the table below.

If you have existing custom attributes already defined with names listed in the Product attribute name column, rename them to match the SKU attribute name column before onboarding to SKU indexing. For example, if you used price as the attribute name, rename it to sku_price.

SKU attribute nameProduct attribute nameSingle or multi value
sku_pricepriceSingle
sku_sale_pricesale_priceSingle
sku_colorcolorSingle
sku_color_groupcolor_groupSingle
sku_sizesizeSingle

Facet management works the same way for SKU attributes as it does for product-level attributes. You can modify attributes and customize their values.

Use custom SKU attributes

To enable custom SKU attributes, contact your Bloomreach representative.

Sorting SKU attributes

Sorting is only supported for the five reserved SKU attributes listed in the table above.

Merchandising SKU attributes

For any SKU attribute, the only supported merchandising operations are Include Only and Exclude. Other operations such as Boost, Bury, and so on, are not supported. Review the API merchandising guide.

Define a default SKU

To set a product's default SKU, add an attribute named default_sku with a value of true.

In the example below, variant 43589801 is defined as the default SKU for the product:

"value": {
  "attributes": {
  },
  "variants": {
    "43589801": {
      "attributes": {
        "size": "xlarge",
        "availability": true,
        "default_sku": true //Defines this SKU as the default SKU for this product
      }
    }
  }
}
📘

Note

The only accepted value for default_sku is true. Sending "default_sku": false may cause issues.

Display Hero SKU price and sale price

You can display the price and sale_price attributes of the Hero SKU that Bloomreach dynamically selects. These values are retrievable in the API response.

The table below describes the behavior of each attribute:

AttributeDescriptionRetrieved in API? (fl)SortableFacetable
hero_sku_priceThe price of the Hero SKU
hero_sku_sale_priceThe sale price of the Hero SKU
🚧

Important

You can't apply faceting or sorting on Hero SKU price and sale price at this time.


© Bloomreach, Inc. All rights reserved.