Search API Response
Overview
There are a few key differences between the Classic Groupby Response and the Google Powered Groupby Response. Some of the main differences are found in the Categories array, and within the product record structure. This document details the structure of the response from the search API. We will outline the format of the response by looking at each possible component that could return.
area
The Area of Command Center that was used when this query fired. If you didn’t specify anything, ‘Production’ will be used.
JSON Reference:
{ "area": "Production" }
availableNavigation
This section will return all the Dynamic Navigations defined in Command Center, that had available refinements for the given set of results, as well as relevant Navigations/Facets determined by Google’s algorithm for that result set if dynamicFacet:true is defined in the request.
This portion can be used to render your left hand side navigation.
If a Navigation’s source property is returned as Dynamic this means it is present as a result of the dynamicFacet:true paremeter
"availableNavigation": [
{
"name": "categories",
"displayName": "Categories",
"type": "Value",
"refinements": [
{
"type": "Value",
"count": 3,
"value": "Handbags & Accessories"
},
{
"type": "Value",
"count": 6,
"value": "Juniors"
},
{
"type": "Value",
"count": 2,
"value": "Juniors > Leggings & Pants"
},
{
"type": "Value",
"count": 10,
"value": "Kids & Baby"
},
{
"type": "Value",
"count": 41,
"value": "Men"
},
{
"type": "Value",
"count": 41,
"value": "Men > Jeans"
},
{
"type": "Value",
"count": 302,
"value": "Women"
},
{
"type": "Value",
"count": 1,
"value": "Women > Jackets & Blazers"
},
{
"type": "Value",
"count": 250,
"value": "Women > Jeans"
},
{
"type": "Value",
"count": 3,
"value": "Women > Pants & Capris"
},
{
"type": "Value",
"count": 40,
"value": "Women > Petite"
},
{
"type": "Value",
"count": 40,
"value": "Women > Petite > Jeans"
},
{
"type": "Value",
"count": 1,
"value": "Women > Swimwear"
}
],
"or": false,
"metadata": []
},
{
"name": "attributes.specialSize",
"displayName": "specialSize",
"type": "Value",
"refinements": [
{
"type": "Value",
"count": 2,
"value": "Big & Tall"
},
{
"type": "Value",
"count": 54,
"value": "Juniors"
},
{
"type": "Value",
"count": 41,
"value": "Petites"
},
{
"type": "Value",
"count": 38,
"value": "Plus Sizes"
},
{
"type": "Value",
"count": 200,
"value": "Regular"
}
],
"or": true,
"source": "Dynamic",
"metadata": []
},Only attributes that exist in your product Catalog/ on product records can be used as Navigations/Facet groups.
Groupby will only use data available in the product catalog for filtering
biasingProfile
The biasing profile used to define the order of results within the returned products.
This can be controlled by settings at:
- Area level (defined in Command Center)
- Rule level, which will override Area settings (defined in Command Center)
- Query level, which will override Rule and Area settings (defined in api request)
JSON Reference:
{ "biasingProfile": "Preferred_Brand_Bias" }
correctedQuery
If Autocorrection was applied, this will be returned with the corrected query. This is omitted when no autocorrect was applied.
Autocorrect
Let’s say my query of jeeans is autocorrected to jeans.
JSON Reference:
{ "correctedQuery": "jeans" }
originalQuery
Returned if autocorrect, stop vword, or a spell correction via Command Center was applied.
Autocorrect
Let’s say my query of egle is autocorrected to eagle.
JSON Reference:
{ "originalQuery": "egle" }
Spelling correction via Command Center
Let’s say my query of egle is spell corrected to penguin via Command Center due to a merchandising decision.
JSON Reference:
{ "originalQuery": "egle" }
Stopwords via Command Center
Let’s say I added “record” as a stop word, and the customer searched for dress record.
JSON Reference:
{ "originalQuery": "dress record" }
pageInfo
Returns the number of the starting and last record within the response. This is 1-indexed. If your page size is larger than the number of returned records, this will return the number of the last record.
JSON Reference:
{ "pageInfo": [ { "recordStart": "1", "recordEnd": "43" } ] }
query
Holds the final text that was used in the query to the engine.
In other words, changes by the engine, like autocorrection or synonyms, are not reflected here. Changes made by a merchandiser via Command Center, like a spell correction or a stop word, are reflected here.
If synonyms are applied, only the content of this field will be used to check against the rules.
Autocorrect
If an autocorrect was applied, this will hold the original query.
Let’s say my query of egle is autocorrected to eagle.
JSON Reference:
{ "query": "egle" }
Spelling correction via Command Center
If spell correction by a merchandiser via Command Center was applied, this will hold the corrected, new query.
Let’s say my query of egle is spell corrected to penguin via Command Center due to a merchandising decision.
JSON Reference:
{ "query": "penguin" }
Stopwords via Command Center
If a stop word was added by a merchandiser, and applied against the query, this will hold the corrected, new query.
Let’s say I added record as a stopword, and the customer searched for dress record.
JSON Reference:
{ "query": "dress" }
records
This returns a nested array, with each top-level item representing a unique result in the record set.
JSON Reference:
"records": [
{
"_id": "62c4643326a0f59351eb4cc80ec10961",
"_u": "http://apparel1productsClothing.com/1724265",
"_t": "Ryan Seacrest Distinction Navy Suit Separates, Neck Tie & Dress Shirt",
"collection": "productsClothing",
"allMeta": {
"brands": [
"Ryan Seacrest Distinction"
],
"variantRollUpValues": [
{
"value": [
"36S",
"36x30",
"38x32",
"38S",
"38L",
"44L",
"15.5 34/35",
"17.5 34/35",
"18 34/35",
"16 32/33",
"17 34/35",
"17 36/37"
],
"count": 12,
"key": "sizes"
},
{
"value": [
"Blue",
"White"
],
"count": 2,
"key": "colorFamilies"
}
],
"name": "projects/481981906177/locations/global/catalogs/default_catalog/branches/0/products/1724265",
"rating": {
"averageRating": 4.8
},
"categories": [
"Men > Suits & Suit Separates",
"Men"
],
"variants": [
{
"name": "projects/481981906177/locations/global/catalogs/default_catalog/branches/0/products/800773054299",
"id": "800773054299",
"type": "VARIANT",
"title": "Ryan Seacrest Distinction Navy Suit Separates, Neck Tie & Dress Shirt",
"priceInfo": {
"currencyCode": "CAD",
"price": 400.0,
"originalPrice": 400.0
},
"availability": "IN_STOCK",
"uri": "www.apparel.com/products/800773054299",
"images": [
{
"uri": "https://storage.googleapis.com/poc_apparel/images/7/optimized/2311647_fpx.tif"
}
],
"colorInfo": {
"colorFamilies": [
"Blue"
],
"colors": [
"New Blue"
]
},
"sizes": [
"36S"
]
},
{
"name": "projects/481981906177/locations/global/catalogs/default_catalog/branches/0/products/800773056279",
"id": "800773056279",
"type": "VARIANT",
"title": "Ryan Seacrest Distinction Navy Suit Separates, Neck Tie & Dress Shirt",
"priceInfo": {
"currencyCode": "CAD",
"price": 150.0,
"originalPrice": 150.0
},
"availability": "IN_STOCK",
"uri": "www.apparel.com/products/800773056279",
"images": [
{
"uri": "https://storage.googleapis.com/poc_apparel/images/7/optimized/2311647_fpx.tif"
}
],
"colorInfo": {
"colorFamilies": [
"Blue"
],
"colors": [
"New Blue"
]
},
"sizes": [
"36x30"
]
},
{
"name": "projects/481981906177/locations/global/catalogs/default_catalog/branches/0/products/800773056316",
"id": "800773056316",
"type": "VARIANT",
"title": "Ryan Seacrest Distinction Navy Suit Separates, Neck Tie & Dress Shirt",
"priceInfo": {
"currencyCode": "CAD",
"price": 150.0,
"originalPrice": 150.0
},
"availability": "IN_STOCK",
"uri": "www.apparel.com/products/800773056316",
"images": [
{
"uri": "https://storage.googleapis.com/poc_apparel/images/7/optimized/2311647_fpx.tif"
}
],
"colorInfo": {
"colorFamilies": [
"Blue"
],
"colors": [
"New Blue"
]
},
"sizes": [
"38x32"
]
},
{
"name": "projects/481981906177/locations/global/catalogs/default_catalog/branches/0/products/824972241144",
"id": "824972241144",
"type": "VARIANT",
"title": "Ryan Seacrest Distinction Navy Suit Separates, Neck Tie & Dress Shirt",
"priceInfo": {
"currencyCode": "CAD",
"price": 400.0,
"originalPrice": 400.0
},
"availability": "IN_STOCK",
"uri": "www.apparel.com/products/824972241144",
"images": [
{
"uri": "https://storage.googleapis.com/poc_apparel/images/7/optimized/2311647_fpx.tif"
}
],
"colorInfo": {
"colorFamilies": [
"Blue"
],
"colors": [
"New Blue"
]
},
"sizes": [
"36S"
]
},
{
"name": "projects/481981906177/locations/global/catalogs/default_catalog/branches/0/products/824972241168",
"id": "824972241168",
"type": "VARIANT",
"title": "Ryan Seacrest Distinction Navy Suit Separates, Neck Tie & Dress Shirt",
"priceInfo": {
"currencyCode": "CAD",
"price": 400.0,
"originalPrice": 400.0
},
"availability": "IN_STOCK",
"uri": "www.apparel.com/products/824972241168",
"images": [
{
"uri": "https://storage.googleapis.com/poc_apparel/images/7/optimized/2311647_fpx.tif"
}
],
"colorInfo": {
"colorFamilies": [
"Blue"
],
"colors": [
"New Blue"
]
},
"sizes": [
"38S"
]
}
],
"id": "1724265",
"title": "Ryan Seacrest Distinction Navy Suit Separates, Neck Tie & Dress Shirt",
"uri": "www.apparel.com/products/1724265"
}
},
{
"_id": "ca9f9f0dfbb5064ce5d81c1c5975d6d1",
"_u": "http://apparel1productsClothing.com/1724267",
"_t": "Ryan Seacrest Distinction Grey Suit Separates, Neck Tie & Dress Shirt",
"collection": "productsClothing",
"allMeta": {
"brands": [
"Ryan Seacrest Distinction"
],
"variantRollUpValues": [
{
"value": [
"30",
"34",
"30x30",
"30x32",
"32x32",
"33x30",
"34x30",
"36x30",
"36x34",
"16.5 32/33",
"17 32/33",
"16 34/35",
"17.5 34/35",
"18 36/37",
"36R",
"38S",
"38R",
"38L",
"40R",
"40L",
"42R",
"44R",
"44L",
"15.5 34/35",
"15 32/33",
"15.5 32/33",
"15 34/35",
"18 34/35"
],
"count": 28,
"key": "sizes"
},
{
"value": [
"Multi",
"Gray",
"Blue",
"Purple",
"White"
],
"count": 5,
"key": "colorFamilies"
}
],
"name": "projects/481981906177/locations/global/catalogs/default_catalog/branches/0/products/1724267",
"rating": {
"averageRating": 4.7
},
"categories": [
"Men > Suits & Suit Separates",
"Men"
],
"variants": [
{
"name": "projects/481981906177/locations/global/catalogs/default_catalog/branches/0/products/26217029191",
"id": "26217029191",
"type": "VARIANT",
"title": "Ryan Seacrest Distinction Grey Suit Separates, Neck Tie & Dress Shirt",
"priceInfo": {
"currencyCode": "CAD",
"price": 45.0,
"originalPrice": 45.0
},
"availability": "IN_STOCK",
"uri": "www.apparel.com/products/26217029191",
"images": [
{
"uri": "https://storage.googleapis.com/poc_apparel/images/1/optimized/2311651_fpx.tif"
}
],
"colorInfo": {
"colorFamilies": [
"Multi"
],
"colors": [
"TAN/BLACK"
]
},
"sizes": [
"30"
]
},
{
"name": "projects/481981906177/locations/global/catalogs/default_catalog/branches/0/products/26217029214",
"id": "26217029214",
"type": "VARIANT",
"title": "Ryan Seacrest Distinction Grey Suit Separates, Neck Tie & Dress Shirt",
"priceInfo": {
"currencyCode": "CAD",
"price": 45.0,
"originalPrice": 45.0
},
"availability": "IN_STOCK",
"uri": "www.apparel.com/products/26217029214",
"images": [
{
"uri": "https://storage.googleapis.com/poc_apparel/images/1/optimized/2311651_fpx.tif"
}
],
"colorInfo": {
"colorFamilies": [
"Multi"
],
"colors": [
"TAN/BLACK"
]
},
"sizes": [
"34"
]
},
{
"name": "projects/481981906177/locations/global/catalogs/default_catalog/branches/0/products/622363759564",
"id": "622363759564",
"type": "VARIANT",
"title": "Ryan Seacrest Distinction Grey Suit Separates, Neck Tie & Dress Shirt",
"priceInfo": {
"currencyCode": "CAD",
"price": 150.0,
"originalPrice": 150.0
},
"availability": "IN_STOCK",
"uri": "www.apparel.com/products/622363759564",
"images": [
{
"uri": "https://storage.googleapis.com/poc_apparel/images/1/optimized/2311651_fpx.tif"
}
],
"colorInfo": {
"colorFamilies": [
"Gray"
],
"colors": [
"Grey"
]
},
"sizes": [
"30x30"
]
},
{
"name": "projects/481981906177/locations/global/catalogs/default_catalog/branches/0/products/622363759571",
"id": "622363759571",
"type": "VARIANT",
"title": "Ryan Seacrest Distinction Grey Suit Separates, Neck Tie & Dress Shirt",
"priceInfo": {
"currencyCode": "CAD",
"price": 150.0,
"originalPrice": 150.0
},
"availability": "IN_STOCK",
"uri": "www.apparel.com/products/622363759571",
"images": [
{
"uri": "https://storage.googleapis.com/poc_apparel/images/1/optimized/2311651_fpx.tif"
}
],
"colorInfo": {
"colorFamilies": [
"Gray"
],
"colors": [
"Grey"
]
},
"sizes": [
"30x32"
]
},
{
"name": "projects/481981906177/locations/global/catalogs/default_catalog/branches/0/products/622363759595",
"id": "622363759595",
"type": "VARIANT",
"title": "Ryan Seacrest Distinction Grey Suit Separates, Neck Tie & Dress Shirt",
"priceInfo": {
"currencyCode": "CAD",
"price": 150.0,
"originalPrice": 150.0
},
"availability": "IN_STOCK",
"uri": "www.apparel.com/products/622363759595",
"images": [
{
"uri": "https://storage.googleapis.com/poc_apparel/images/1/optimized/2311651_fpx.tif"
}
],
"colorInfo": {
"colorFamilies": [
"Gray"
],
"colors": [
"Grey"
]
},
"sizes": [
"32x32"
]
}
],
"id": "1724267",
"title": "Ryan Seacrest Distinction Grey Suit Separates, Neck Tie & Dress Shirt",
"uri": "www.apparel.com/products/1724267"
}
},
{
"_id": "82e0cc923ca2b88c8122098b5f6ca965",
"_u": "http://apparel1productsClothing.com/1724266",
"_t": "Ryan Seacrest Distinction Black Suit Separates, Blue Dress Shirt & Neck",
"collection": "productsClothing",
"allMeta": {
"brands": [
"Ryan Seacrest Distinction"
],
"variantRollUpValues": [
{
"value": [
"Black",
"White",
"Blue"
],
"count": 3,
"key": "colorFamilies"
},
{
"value": [
"42R",
"40R",
"30x30",
"30x32",
"32x32",
"33x32",
"34x30",
"36x34",
"38R",
"38L",
"46L",
"14.5 32/33",
"15.5 32/33",
"16 32/33",
"17 32/33",
"17.5 32/33",
"15 34/35",
"16 34/35"
],
"count": 18,
"key": "sizes"
}
],
"name": "projects/481981906177/locations/global/catalogs/default_catalog/branches/0/products/1724266",
"rating": {
"averageRating": 4.6
},
"categories": [
"Men > Suits & Suit Separates",
"Men"
],
"variants": [
{
"name": "projects/481981906177/locations/global/catalogs/default_catalog/branches/0/products/800773054237",
"id": "800773054237",
"type": "VARIANT",
"title": "Ryan Seacrest Distinction Black Suit Separates, Blue Dress Shirt & Neck",
"priceInfo": {
"currencyCode": "CAD",
"price": 199.99,
"originalPrice": 400.0
},
"availability": "IN_STOCK",
"uri": "www.apparel.com/products/800773054237",
"images": [
{
"uri": "https://storage.googleapis.com/poc_apparel/images/0/optimized/2311650_fpx.tif"
}
],
"colorInfo": {
"colorFamilies": [
"Black"
],
"colors": [
"Black"
]
},
"sizes": [
"42R"
]
},
{
"name": "projects/481981906177/locations/global/catalogs/default_catalog/branches/0/products/800773054992",
"id": "800773054992",
"type": "VARIANT",
"title": "Ryan Seacrest Distinction Black Suit Separates, Blue Dress Shirt & Neck",
"priceInfo": {
"currencyCode": "CAD",
"price": 199.99,
"originalPrice": 400.0
},
"availability": "IN_STOCK",
"uri": "www.apparel.com/products/800773054992",
"images": [
{
"uri": "https://storage.googleapis.com/poc_apparel/images/0/optimized/2311650_fpx.tif"
}
],
"colorInfo": {
"colorFamilies": [
"Black"
],
"colors": [
"Black"
]
},
"sizes": [
"40R"
]
},
{
"name": "projects/481981906177/locations/global/catalogs/default_catalog/branches/0/products/800773056347",
"id": "800773056347",
"type": "VARIANT",
"title": "Ryan Seacrest Distinction Black Suit Separates, Blue Dress Shirt & Neck",
"priceInfo": {
"currencyCode": "CAD",
"price": 99.99,
"originalPrice": 150.0
},
"availability": "IN_STOCK",
"uri": "www.apparel.com/products/800773056347",
"images": [
{
"uri": "https://storage.googleapis.com/poc_apparel/images/0/optimized/2311650_fpx.tif"
}
],
"colorInfo": {
"colorFamilies": [
"Black"
],
"colors": [
"Black"
]
},
"sizes": [
"30x30"
]
},
{
"name": "projects/481981906177/locations/global/catalogs/default_catalog/branches/0/products/800773056354",
"id": "800773056354",
"type": "VARIANT",
"title": "Ryan Seacrest Distinction Black Suit Separates, Blue Dress Shirt & Neck",
"priceInfo": {
"currencyCode": "CAD",
"price": 99.99,
"originalPrice": 150.0
},
"availability": "IN_STOCK",
"uri": "www.apparel.com/products/800773056354",
"images": [
{
"uri": "https://storage.googleapis.com/poc_apparel/images/0/optimized/2311650_fpx.tif"
}
],
"colorInfo": {
"colorFamilies": [
"Black"
],
"colors": [
"Black"
]
},
"sizes": [
"30x32"
]
},
{
"name": "projects/481981906177/locations/global/catalogs/default_catalog/branches/0/products/800773056378",
"id": "800773056378",
"type": "VARIANT",
"title": "Ryan Seacrest Distinction Black Suit Separates, Blue Dress Shirt & Neck",
"priceInfo": {
"currencyCode": "CAD",
"price": 99.99,
"originalPrice": 150.0
},
"availability": "IN_STOCK",
"uri": "www.apparel.com/products/800773056378",
"images": [
{
"uri": "https://storage.googleapis.com/poc_apparel/images/0/optimized/2311650_fpx.tif"
}
],
"colorInfo": {
"colorFamilies": [
"Black"
],
"colors": [
"Black"
]
},
"sizes": [
"32x32"
]
}
],
"id": "1724266",
"title": "Ryan Seacrest Distinction Black Suit Separates, Blue Dress Shirt & Neck",
"uri": "www.apparel.com/products/1724266"
}
}
],