System attributes
Welcome note
Data hub is our new upgraded platform, which we rolled out in August 2025. It offers a single unified integration for passing your data through to your Bloomreach products.
You have access to Data hub if you've implemented with Bloomreach after August 2025.
Customers who have implemented before August 2025 should follow the existing documentation for Engagement, Discovery, and Clarity.
Standard platform attributes
Core product attributes that are universally supported across all Bloomreach applications and form the foundation of product data.
These standard fields enable essential functionality, such as display, availability control, and basic personalization and merchandising, across the platform.
General
| Attribute | Description | Data Type & Example |
|---|---|---|
URL url Product / Variant | Canonical URL for viewing or purchasing the product | Stringhttps://example-store.com/products/classic-cott... |
Title title Product / Variant | The name of the product or variant | StringClassic Fit Cotton T-Shirt |
Description description Product / Variant | Detailed product information text | StringExperience ultimate comfort with our Classic Fit
Cotton T-Shirt.
Made from 100% organic cotton, this versatile wardrobe essential features
a relaxed fit that flatters every body type.
The premium ring-spun cotton fabric is pre-shrunk and features reinforced shoulder seams
for lasting durability.
Perfect for casual wear, layering, or everyday comfort.
Machine washable and fade-resistant. |
Default Variant default_variant Variant only | Indicates whether a variant is considered the default or primary variant for a product | BooleanTrue |
Active activeProduct / Variant | Indicates whether the product or variant is active and available for sale | BooleanTrue |
Launch Date launch_date Product / Variant | The date and time when the product or variant was first made available for sale | Datetime2024-03-15
10:30:00+00:00 |
Brand brand Product / Variant | Identifies the brand name of a product or variant | StringNike |
Color color Product / Variant | Represents the primary color of a product or variant | StringNavy Blue |
Gender genderProduct / Variant | Identifies the primary gender designation for a product or variant | StringWomen |
Size size Product / Variant | Represents the primary size designation of a product or variant | StringMedium |
Pricing and inventory
| Attribute | Description | Data Type & Example |
|---|---|---|
Price price Product / Variant | Final price after discounts and promotions | Float599.99 |
Original Price original_price Product / Variant | The initial product or variant price before any discounts or promotions | Float599.99 |
Inventory Stock
Level stock_level Product / Variant | The on-hand or available-to-sell stock level for the product or variant | Integer150 |
Media
| Attribute | Description | Data Type & Example |
|---|---|---|
Large Image Link large_image Product / Variant | High-resolution image URL for the product or variant | Stringhttps://cdn.example.com/products/shoes/running-... |
Thumbnail Image
Link thumb_image Product / Variant | Thumbnail image URL for the product or variant | Stringhttps://cdn.example.com/products/shoes/running-... |
Swatch Image
Link swatch_image Variant only | Swatch image URL for the variant showing distinguishing visual characteristics | Stringhttps://cdn.example.com/products/swatches/shirt... |
Categories
| Attribute | Description | Data Type & Example |
|---|---|---|
Category Paths category_paths Product only | Stores all categorical information about the product including category names and hierarchical structure | CategoryPaths[[{'name': 'dresses'}]] |
Misc
| Attribute | Description | Data Type & Example |
|---|---|---|
Product Class product_class Product only | Defines the classification of a product that determines its processing and runtime behavior | Stringsimple |
Exclude From Apps exclude_from_apps Product / Variant | Specifies which applications should not receive the product or variant during data distribution | List.String['discovery'] |
Variant Options variant_options Product only | An ordered list of variant attribute names that define the grouping and organization structure | List.String['color', 'size'] |
Engagement attributes
Attributes used for customer engagement, personalization, and marketing campaigns.
Pricing
| Attribute | Description | Data Type & Example |
|---|---|---|
Discount Percentagediscount_percentage Product / Variant | The percentage discount applied to the product or variant | Float25.0 |
Discount
Value discount_value Product / Variant | The absolute discount amount applied to the product or variant | Float25.0 |
Cost Per
Unit cost_per_unit Product / Variant | The wholesale cost or purchase price of the product or variant | Float45.5 |
General
| Attribute | Description | Data Type & Example |
|---|---|---|
Lead Time lead_time Product / Variant | Specifies the time needed for re-stocking of the product from the supplier | String7 |
Supplier supplier Product / Variant | Identifies the supplier for this product through a name or identifier | StringAcme Corporation |
Returned Products returned_products Product / Variant | Tracks the number of returned products or variants of this type | Integer5 |
Discovery attributes
Attributes that enhance product discovery and search capabilities.
Pricing
| Attribute | Description | Data Type & Example |
|---|---|---|
Price Range Override price_range Product only | A two-element array that overrides the automatically calculated product-level price range | List.Float[49.99, 149.99] |
Original Price Range
Override original_price_range Product only | A two-element array that overrides the product-level regular price range calculation | List.Float[79.99, 199.99] |
General
| Attribute | Description | Data Type & Example |
|---|---|---|
Color Group color_group Product / Variant | Represents the normalized color family name for a product or variant | StringRed |
Keywords keywords Product only | Contains a list of keywords and terms to enhance search relevance | List.String['running', 'shoes', 'sneakers', 'trainers',
'athletic', 'footwear', 'jogging'] |
Reviews reviewsProduct only | Represents the aggregated score from all reviews for a product | Float4.5 |
Flags flags Product only | Contains product flags or tags for categorization and filtering | List.String['new-arrival', 'sale', 'bestseller'] |
Promotions promotions Product only | Contains active promotions and relevant keywords for promotional campaigns | List.String['black-friday',
'50-percent-off', 'clearance'] |
Condition condition Product only | Specifies the condition of the product | Stringnew |
Capacity capacity Product only | Represents the numeric capacity of a product where applicable | Float256.0 |
Width width Product only | Represents the product width measurement where applicable | Float24.5 |
Height heightProduct only | Represents the product height measurement where applicable | Float72.0 |
Depth depth Product only | Represents the product depth or length measurement where applicable | Float20.0 |
High Confidence
Terms high_confidence_terms Product only | Contains terms closely associated with the product that should be explicitly boosted for ranking | List.String['iphone-15-pro', 'apple-smartphone', 'ios-device'] |
Updated 7 days ago