System attributes
A comprehensive overview of all system attributes with their key properties and links to full specifications. They are grouped based on common use cases.
Jump to group:
- Standard Platform Attributes
- Marketing Attributes
- Search Attributes
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 like display, availability control, and basic personalization and merchandising across the platform.
Jump to section:
General
| Attribute | Description | Data Type & Example |
|---|---|---|
Product / Variant | Canonical URL for viewing or purchasing the product | Stringhttps://example-store.com/products/classic-cott |
Product / Variant | The name of the product or variant | StringClassic Fit Cotton T-Shirt |
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. |
Variant only | Indicates whether a variant is considered the default or primary variant for a product | BooleanTrue |
Product / Variant | Indicates whether the product or variant is active and available for sale | BooleanTrue |
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 |
Product / Variant | Identifies the brand name of a product or variant | StringNike |
Product / Variant | Represents the primary color of a product or variant | StringNavy Blue |
Product / Variant | Identifies the primary gender designation for a product or variant | StringWomen |
Product / Variant | Represents the primary size designation of a product or variant | StringMedium |
Pricing & Inventory
| Attribute | Description | Data Type & Example |
|---|---|---|
Product / Variant | Final price after discounts and promotions | Float599.99 |
Product / Variant | The initial product or variant price before any discounts or promotions | Float599.99 |
Product / Variant | The on-hand or available-to-sell stock level for the product or variant | Integer150 |
Media
| Attribute | Description | Data Type & Example |
|---|---|---|
Product / Variant | High-resolution image URL for the product or variant | Stringhttps://cdn.example.com/products/shoes/running- |
Product / Variant | Thumbnail image URL for the product or variant | Stringhttps://cdn.example.com/products/shoes/running- |
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 only | Defines the classification of a product that determines its processing and runtime behavior | Stringsimple |
Product / Variant | Specifies which applications should not receive the product or variant during data distribution | List.String['discovery'] |
Product only | An ordered list of variant attribute names that define the grouping and organization structure | List.String['color', 'size'] |
Marketing Attributes
Attributes used for customer engagement, personalization, and marketing campaigns.
Jump to section:
Pricing
| Attribute | Description | Data Type & Example |
|---|---|---|
Product / Variant | The percentage discount applied to the product or variant | Float25.0 |
Product / Variant | The absolute discount amount applied to the product or variant | Float25.0 |
Product / Variant | The wholesale cost or purchase price of the product or variant | Float45.5 |
General
| Attribute | Description | Data Type & Example |
|---|---|---|
Product / Variant | Specifies the time needed for re-stocking of the product from the supplier | String7 |
Product / Variant | Identifies the supplier for this product through a name or identifier | StringAcme Corporation |
Product / Variant | Tracks the number of returned products or variants of this type | Integer5 |
Search Attributes
Attributes that enhance product discovery and search capabilities.
Jump to section:
Pricing
| Attribute | Description | Data Type & Example |
|---|---|---|
Product only | A two-element array that overrides the automatically calculated product-level price range | List.Float[49.99, 149.99] |
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 |
|---|---|---|
Product / Variant | Represents the normalized color family name for a product or variant | StringRed |
Product only | Contains a list of keywords and terms to enhance search relevance | List.String['running', 'shoes', 'sneakers', 'trainers', 'athletic', 'footwear', 'jogging'] |
Product only | Represents the aggregated score from all reviews for a product | Float4.5 |
Product only | Contains product flags or tags for categorization and filtering | List.String['new-arrival', 'sale', 'bestseller'] |
Product only | Contains active promotions and relevant keywords for promotional campaigns | List.String['black-friday', '50-percent-off', 'clearance'] |
Product only | Specifies the condition of the product | Stringnew |
Product only | Represents the numeric capacity of a product where applicable | Float256.0 |
Product only | Represents the product width measurement where applicable | Float24.5 |
Product only | Represents the product height measurement where applicable | Float72.0 |
Product only | Represents the product depth or length measurement where applicable | Float20.0 |
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 12 days ago