Reserved attributes

This guide introduces you to reserved attributes and provides a detailed reference to the attributes.

What are reserved attributes

Reserved attributes are Bloomreach reserved keywords used in feed processing to assign attributes like price, availability, and size using set terminology. Bloomreach consumes these attributes to create a basic understanding of your product catalog and process it within the Bloomreach algorithm.

For example, the price attribute is reserved and must be used to send product pricing details to Bloomreach. If you use a custom attribute with variations like my_price or product_price, Bloomreach won't treat it as the product's price.

Mandatory attributes

Discovery requires 3 mandatory attributes:

title
price
url

The remaining attributes are highly recommended but not mandatory. If you've integrated via Data hub, view the detailed System attributes documentation.

Reserved object names

Data hub integration

Reserved object names don't apply to Data hub integrations.

Non-Data hub integration

There are 5 reserved object names used in the product record JSON, which should be avoided as attribute names:

op
path
views
variants
attributes

Using reserved attributes

When using reserved attributes to build front-end components, note details like data type and facetable properties to use them correctly.

For example, the reserved attribute price is a number. Trying to filter it as a string returns an error in the API response because it's not supported in the API.

Guidelines for catalogs with variants

These apply to all integrations.

Pricing

If your catalog includes variants, send pricing information at the variant level only.

If you send pricing at both the product and variant levels, the system may choose the product-level price and incorrectly apply it to variants where it shouldn't be used.

To ensure accurate pricing display:

Structure your data with pricing set at the variant level.
Avoid sending pricing attributes at the product (parent) level.
Let each variant carry its own:
- price and sale_price values for non-Data hub integrations.
- price and original_price values for Data hub integrations.

For both integrations: when querying Search APIs, reference price andsale_price.

Querying variant attributes

When querying Search APIs for products with variants, append a sku_ prefix to the source attribute name in query parameters when filtering, sorting, or returning these attributes.

The following attributes use the sku_ prefix at the variant level:

sku_price (for price)
sku_sale_price (for sale_price)
sku_color (for color)
sku_color_group (for color_group)
sku_size (for size)

For example, to filter by a variant's color or retrieve a variant's price in your query parameters, use sku_color or sku_price instead of just color or price. See the complete SKU Select attributes documentation.

Data hub system attribute mapping

For Data hub integrations, reserved attributes map to Data hub system attributes. Few might map to a system attribute with a slightly different name.

For example, the reserved attribute availability maps to the system attribute active.

This means that you send input data with the system attribute name active. However, to use the attribute in Discovery, you must use the reserved attribute name availability.