Reserved Fields are a list of Bloomreach reserved keywords used in feed processing to assign attributes like price, availability, size, etc. using a set terminology. These are consumed by Bloomreach to create a basic understanding of your product catalog and how to process it within the scope of the Bloomreach algorithm. For example, the “price” field is a Reserved Field and must be used to send the details of the price of your product to Bloomreach. If you use a custom field with variations like “my_price” or “product_price” etc. Bloomreach will not treat it as the price of the product.
Reserved Fields are reserved keywords/attributes/fields that cannot be used externally for any field mapping. For example, the field "sale_price" is used to capture price of a product on sale. In Dev Studio, mapping an external dynamic attribute to "sale_price" does not work.
Mandatory fields
There are 8 mandatory Reserved Fields that must be sent to Bloomreach during feed processing. The current list of mandatory Reserved Fields are:
- title
- category_paths
- price
- description
- url
- availability
- brand
- thumb_image
Reserved object names
There are 5 reserved object names that are used in the product record JSON, which should be avoided as attribute names:
- op
- path
- views
- variants
- attributes
Using Reserved Fields
While using the reserved fields for building any of the front end components, note details like Data Type, Facetable to use them correctly. For example, the Reserved Field “price” is a number, and trying to filter it as a string returns an error in the API response as it is not supported in the API.
| S.no. | Reserved Fields | Required | Data Type | Facetable | Displayable | Field Type (Single/Multivalued) | Returned in API response as |
|---|---|---|---|---|---|---|---|
| 1 | availability | Yes | Boolean | No | No | Single | Not returned in API response |
| 2 | best_seller | No | Number | No | Can be fetched as FL (stored, indexed field) | Single | Same as reserved field name |
| 3 | brand | No | Text | Yes | Yes | Single | Same as reserved field name |
| 4 | bundle_id | No | Text | No | Unstored, indexed field | Multivalued | Same as reserved field name |
| 5 | capacity | No | Number | No | No | Single | Same as reserved field name |
| 6 | category_paths | Yes | Text | Yes | No | Multivalued | category (Note: Category_paths is returned as the category) |
| 7 | city_location | No | Array (city_location uses the same input format as store_location) | Yes | Yes | Multi-valued | Note that no feature uses this reserved attribute. |
| 8 | color | No | Text | Yes Note: Facet values of this attribute are converted to lowercase after feed indexing. | Yes | Single | colors |
| 9 | color_group | No | Text | Yes Note: Facet values of this attribute are converted to lowercase after feed indexing. | Yes | Single | color_groups |
| 10 | depth | No | Number | No | No | Single | Same as reserved field name |
| 11 | description | Yes | Text | No | Yes | Single | Same as reserved field name |
| 12 | flag | No | Boolean | No | Same as reserved field name | ||
| 13 | gender | No | Text | Yes | Yes | Single | Same as reserved field name |
| 14 | google_category | No | No | Same as reserved field name | |||
| 15 | height | No | Number | No | No | Single | Same as reserved field name |
| 16 | is_sellable | No | Boolean | No | Indexed, unstored field | Single | Same as reserved field name |
| 17 | item_no | No | Text | No | No | Multivalued | Same as reserved field name |
| 18 | keywords | No | Text | No | No | Multivalued | Same as reserved field name |
| 19 | large_image | No | Text | Yes | Yes | Multivalued | Same as reserved field name |
| 20 | launch_date | No | Text | No | Yes | Single | Same as reserved field name |
| 21 | leaf_categories | No | Text | No | Multivalued | Same as reserved field name | |
| 22 | model_name | No | Text | No | No | Single | Same as reserved field name |
| 23 | model_no | No | Text | No | No | Multivalued | Same as reserved field name |
| 24 | price | Yes | Number | Yes | Yes | Single | Same as reserved field name |
| 25 | promotion | No | Text | No | Yes | Multivalued | Same as reserved field name |
| 26 | reviews | No | Number | No | No | Single | Not returned in API response |
| 27 | sale_price | No | Number | Yes | Yes | Single | sale_price |
| 28 | size | No | Text | Yes Note: Facet values of this attribute are converted to lowercase after feed indexing. | Yes | Single | sizes |
| 29 | skuid | No | Text | No | Yes | Single | Same as reserved field name |
| 30 | start_date | No | Text | No | Yes | Single | Same as reserved field name |
| 31 | stock_level | No | Text | No | No | Multivalued | Same as reserved field name |
| 32 | store_id | No | Text | No | Indexed not stored | Multivalued | Same as reserved field name |
| 33 | store_location | No | Array | Yes | Yes | Multi-valued | Returns "store_lat_lon.distance" in miles Example: { "docs": [ { "store_lat_lon": [ "38.603336,-121.41535" ], "store_id": "342523", "store_lat_lon.distance": 3.1413424, "pid": "3478", "product_master_id": "3478951", "price": 20, "brand": "Pacifichome" } ] } |
| 34 | thumb_image | Yes | Text | Yes | Yes | Single | Same as reserved field name |
| 35 | title | Yes | Text | No | Yes | Single | Same as reserved field name |
| 36 | url | Yes | Text | No | Yes | Single | Same as reserved field name |
| 37 | width | No | Number | No | No | Single | Same as reserved field name |