Entity templates

In Sitecore Search, an entity, representing a type of content, is a structure or grouping of attributes. Sitecore Search is configured with templates to use when creating custom entities.

The sections in this topic describe the various entity templates built into Sitecore Search including the default entity, Content.

Here are links to procedures to manage your entities:

To create a custom entity, select a template and follow the procedure in Edit or create entities.
To add a custom attribute to an entity, follow the procedure in Add an attribute.
To edit a custom attribute of an entity, follow the procedure in Edit an attribute.

Content (default)

Content is the default entity in Sitecore Search and has attributes typical to content items including id, name, url, among others.

Display name	Attribute name	Data type	Required
Breadcrumbs	breadcrumbs	Array of strings
Content Type	type	String	Required
Description	description	String
Document Activeness	is_active	Boolean
Id	id	String	Required
Image url	image_url	String
Name/Title	name	String
Questions and Answering	rfk_questions	Array of composites
Review rating	review_rating	Float
Source	rfk_source	Composite
Stats	rfk_stats	Composite
Tags	tags	Array of strings
Url	url	String

Base entity

All entities in Sitecore Search, including the default entity Content inherit the attributes of this entity. This is the simplest and most basic entity.

Display name	Attribute name	Data type	Required
Document Activeness	is_active	Boolean
Id	id	String	Required
Source	rfk_source	Composite
Stats	rfk_stats	Composite

Product

Use this template to create a custom entity with attributes typical to products including category_names, brand, sku among others.

Display name	Attribute name	Data type	Required
Add to cart	add_to_cart	String
Additional image SKU urls	additional_sku_image_urls	String
Additional image urls	additional_image_urls	String
All category names	all_category_names	Array of strings
Brand	brand	String
Brand code	brand_code	String
Breadcrumbs	breadcrumbs	String
Bundle SKUs	bundle_skus	String
Category	all_category_ids	Array of strings
Category breadcrumbs	category_breadcrumbs	String
Category ids	category_ids	Array of strings
Category names	category_names	Array of strings
Color	color	String
Color display name	color_display_name	String
Color rgb value	color_rgb	String
Customer Category Identifiers	ccids	Array of strings
Description	description	String
Document Activeness	is_active	Boolean
Expiration Date	expiration_date	String
Final Price	final_price	Float
Hashed image url	image_id	String
Id	id	String	Required
Image url	image_url	String
Is in stock	is_in_stock	Boolean
Margin	margin	Float
Mobile SKU image url	mobile_sku_image_url	String
Mobile SKU url	mobile_sku_url	String
Mobile image url	mobile_image_url	String
Mobile product url	mobile_product_url	String
Name	name	String	Required
On sale	on_sale	Boolean
Price	price	Float
Product	product_group	String
Product lookup field	prod_lookup	Array of strings
Product type	product_type	String
Product url	product_url	String
Quick look	quick_look	String
Quick view	quick_view	String
RFK tags	rfk_tags	Object
Rank By 1	rankby1	Float
Rank By 2	rankby2	Float
Release Date	release_date	String
Review Count	review_count	Integer
Review link	review_link	String
Review rating	review_rating	Float
SKU	sku	String
SKU description	sku_description	String
SKU name	sku_name	String
Save off	save_off	Float
Search keywords	search_keywords	String
Set SKUs keywords	set_skus	String
Short_description	short_description	String
Sku Lookup	sku_lookup	Array of strings
Sku image url	sku_image_url	String
Sku sequence	sku_sequence	Integer
Sku url	sku_url	String
Source	rfk_source	Composite
Stats	rfk_stats	Composite
Stock quantity	stock_quantity	Integer
Stock unit	stock_unit	String
prod_url_key	prod_url_key	String
sku_url_key	sku_url_key	String
swatch	swatch	Array of objects

Display name	Attribute name	Data type	Required
All Category Ids	all_ids	Array of strings
All Category Names	all_names	Array of strings	Required
All Category URL Keys	all_url_keys	Array of strings
All Category URL Paths	all_url_paths	Array of strings
All Customer Category Identifiers	all_ccids	Array of strings
Category Breadcrumbs	breadcrumb	Array of strings
Category Name	name	String	Required
Category Primary	is_primary	Boolean
Category Primary URL	url_path	String
Category Primary Url Key	url_key	String	Required
Customer Category Identifier	ccid	String	Required
Document Activeness	is_active	Boolean
Id	id	String	Required
Parent Category Ids	parent_ids	Array of strings
Parent Customer Category Identifiers	parent_ccids	Array of strings
Source	rfk_source	Composite
Stats	rfk_stats	Composite

Fitment - for custom entity

Use this template to create a custom entity with attributes typical to a product fitment.

Display name	Attribute name	Data type	Required
Ids	ids	Array of strings
Items	items	Array of objects

Store

Use this template to create a custom entity with attributes typical to a store including location, address, group_id, among others.

Display name	Attribute name	Data type
Citizenship required	citizenship_required	String
Group Id	group_id	String
Id	id	String
Job number of positions available	job_number	String
Job shift	job_shift	String
Location in lat long coordinates	location	GEO
Security clearance required	security_clearance_required	String
Used for searching address	address	String

Generic product

Use this template to create a custom entity with attributes for a generic product including category_names, brand, sku, among others.

Display name	Attribute name	Data type	Required
Add to cart	add_to_cart	String
Additional image SKU urls	additional_sku_image_urls	String
Additional image urls	additional_image_urls	String
All category names	all_category_names	Array of strings
Brand	brand	String
Brand code	brand_code	String
Breadcrumbs	breadcrumbs	String
Bundle SKUs	bundle_skus	String
Category	all_category_ids	Array of strings
Category breadcrumbs	category_breadcrumbs	String
Category ids	category_ids	Array of strings
Category names	category_names	Array of strings
Color	color	String
Color display name	color_display_name	String
Color rgb value	color_rgb	String
Customer Category Identifiers	ccids	Array of strings
Description	description	String
Document Activeness	is_active	Boolean
Expiration Date	expiration_date	String
Final Price	final_price	Float
Hashed image url	image_id	String
Id	id	String	Required
Image url	image_url	String
Is in stock	is_in_stock	Boolean
Margin	margin	Float
Mobile SKU image url	mobile_sku_image_url	String
Mobile SKU url	mobile_sku_url	String
Mobile image url	mobile_image_url	String
Mobile product url	mobile_product_url	String
Name	name	String	Required
On sale	on_sale	Boolean
Price	price	Float
Product	product_group	String
Product lookup field	prod_lookup	Array of strings
Product type	product_type	String
Product url	product_url	String
Quick look	quick_look	String
Quick view	quick_view	String
RFK tags	rfk_tags	Object
Rank By 1	rankby1	Float
Rank By 2	rankby2	Float
Release Date	release_date	String
Review Count	review_count	Integer
Review link	review_link	String
Review rating	review_rating	Float
SKU	sku	String
SKU description	sku_description	String
SKU name	sku_name	String
Save off	save_off	Float
Search keywords	search_keywords	String
Set SKUs keywords	set_skus	String
Short_description	short_description	String
Sku Lookup	sku_lookup	Array of strings
Sku image url	sku_image_url	String
Sku sequence	sku_sequence	Integer
Sku url	sku_url	String
Source	rfk_source	Composite
Stats	rfk_stats	Composite
Stock quantity	stock_quantity	Integer
Stock unit	stock_unit	String
prod_url_key	prod_url_key	String
sku_url_key	sku_url_key	String
Swatch	swatch	Array of objects

OrderCloud product

Use this template to create a custom entity with attributes for a product in OrderCloud or an OrderCloud marketplace, including catalogs, XP, shipwidth, among others.

Display name	Attribute name	Data type	Required
Active	active	Boolean
All category names	all_category_names	Array of strings
All suppliers can sell	allsupplierscansell	Boolean
Auto forward	autoforward	Boolean
Brand	brand	String
Breadcrumbs	breadcrumbs	String
Buyers	buyers	Array of strings
Catalogs	catalogs	Array of strings
Categories	categories	Array of objects
Category	all_category_ids	Array of strings
Category ids	category_ids	Array of strings
Category names	category_names	Array of strings
Customer Category Identifiers	ccids	Array of strings
Default price	defaultprice	Float
Default price schedule	defaultpriceschedule	Object
Default price schedule id	defaultpricescheduleid	String
Default supplier ID	defaultsupplierid	String
Description	description	String
Document Activeness	is_active	Boolean
Expiration Date	expiration_date	String
Final Price	final_price	Float
Hashed image url	image_id	String
Id	id	String	Required
Image url	image_url	String
Inventory	inventory	Object
Inventory records	inventoryrecords	Array of objects
Is in stock	is_in_stock	Boolean
Margin	margin	Float
Marketplace	marketplace	String
Name	name	String	Required
On sale	on_sale	Boolean
Owner ID	ownerid	String
Party price schedules	partypriceschedules	Array of objects
Price	price	Float
Product	product_group	String
Product lookup field	prod_lookup	Array of strings
Product url	product_url	String
RFK tags	rfk_tags	Object
Rank By 1	rankby1	Float
Rank By 2	rankby2	Float
Release Date	release_date	String
Returnable	returnable	Boolean
Review Count	review_count	Integer
Review rating	review_rating	Float
SKU	sku	String
Seller default price schedules	sellerdefaultpriceschedules	Array of objects
Ship from address ID	shipfromaddressid	String
Ship height	shipheight	Float
Ship length	shiplength	Float
Ship weight	shipweight	Float
Ship width	shipwidth	Float
Short_description	short_description	String
Sku Lookup	sku_lookup	Array of strings
Sku image url	sku_image_url	String
Sku url	sku_url	String
Source	rfk_source	Composite
Spec count	speccount	Integer
Stats	rfk_stats	Composite
Stock quantity	stock_quantity	Integer
Suppliers	suppliers	Array of strings
User groups	usergroups	Array of strings
Variant count	variantcount	Integer
XP	xp	Object
prod_url_key	prod_url_key	String
sku_url_key	sku_url_key	String
swatch	swatch	Array of objects

OrderCloud2

Use this alternate template to create a custom entity with attributes for a product in OrderCloud or an OrderCloud marketplace, including category_ids, is_in_stock, rankby2, among others.

Display name	Attribute name	Data type	Required
All category names	all_category_names	Array of strings
Brand	brand	String	Required
Breadcrumbs	breadcrumbs	String
Category	all_category_ids	Array of strings
Category ids	category_ids	Array of strings	Required
Category names	category_names	Array of strings
Customer Category Identifiers	ccids	Array of strings
Description	description	String
Document Activeness	is_active	Boolean
Expiration Date	expiration_date	String
Final Price	final_price	Float
Hashed image url	image_id	String
Id	id	String
Image url	image_url	String
Is in stock	is_in_stock	Boolean
Margin	margin	Float
Name	name	String
On sale	on_sale	Boolean
Price	price	Float
Product	product_group	String
Product lookup field	prod_lookup	Array of strings
Product url	product_url	String
RFK tags	rfk_tags	Object
Rank By 1	rankby1	Float
Rank By 2	rankby2	Float
Release Date	release_date	String
Review Count	review_count	Integer
Review rating	review_rating	Float
SKU	sku	String
Short_description	short_description	String
Sku Lookup	sku_lookup	Array of strings
Sku image url	sku_image_url	String
Sku url	sku_url	String
Source	rfk_source	Composite
Stats	rfk_stats	Composite
Stock quantity	stock_quantity	Integer
prod_url_key	prod_url_key	String
sku_url_key	sku_url_key	String
swatch	swatch	Array of objects

Do you have some feedback for us?

If you have suggestions for improving this article,