search
get
/ccagent/v1/search
Search. Perform a search given an endeca based query. The response is a formatted endeca JSON that provides all the data based on the type of search. This Endpoint is clone of StoreFront endpoint and it can be used if application running on agent/admin server need access to endeca based search configured for StoreFront. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : search_response
Type:
Show Source
object-
breadcrumbs(optional):
object breadcrumbs
Breadcrumbs based on the given search query
- navigation(optional): object navigation
-
resultsList(optional):
object resultsList
List of all the results
-
searchAdjustments(optional):
object searchAdjustments
Search Adjustments of the given query
-
zones(optional):
object zones
Zone information where the content falls under
Nested Schema : resultsList
Type:
objectList of all the results
Show Source
-
firstRecNum(optional):
integer
First record number
-
lastRecNum(optional):
integer
Last record number
-
pagingActionTemplate(optional):
object pagingActionTemplate
Template of paging action
-
recsPerPage(optional):
integer
Number of records per page
-
totalNumRecs(optional):
integer
Total Number of Records in the result set
Nested Schema : searchAdjustments
Type:
objectSearch Adjustments of the given query
Show Source
-
originalTerms(optional):
array originalTerms
List of all the original terms
Nested Schema : zones
Type:
objectZone information where the content falls under
Show Source
-
@type(optional):
string
Zone type
-
offset(optional):
integer
Offset value
-
recordsPerPage(optional):
integer
Number of records per page
Nested Schema : pagingActionTemplate
Type:
objectTemplate of paging action
Show Source
-
@class(optional):
string
Path of NavigationAction class
-
contentPath(optional):
string
Path of the content
-
label(optional):
string
Label of action
- navigationState(optional): string
-
siteRootPath(optional):
string
Site Root path of endeca
Example Response (application/json)
{
"resultsList":{
"pagingActionTemplate":{
"contentPath":"/guidedsearch",
"@class":"com.endeca.infront.cartridge.model.NavigationAction",
"navigationState":"?No=%7Boffset%7D&Nrpp=%7BrecordsPerPage%7D&Ntk=product.active%7C&Ntt=1%7Canalog*",
"siteRootPath":"/services",
"label":null
},
"lastRecNum":1,
"totalNumRecs":1,
"sortOptions":[
],
"records":[
{
"@class":"com.endeca.infront.cartridge.model.Record",
"detailsAction":{
"contentPath":"/recorddetails",
"@class":"com.endeca.infront.cartridge.model.RecordAction",
"siteRootPath":"/services",
"label":null,
"recordState":"?A=sku-xsku5016..xprod1004.en__US"
},
"records":[
{
"@class":"com.endeca.infront.cartridge.model.Record",
"detailsAction":{
"contentPath":"/recorddetails",
"@class":"com.endeca.infront.cartridge.model.RecordAction",
"siteRootPath":"/services",
"label":null,
"recordState":"?R=sku-xsku5016..xprod1004.en__US"
},
"records":null,
"numRecords":0,
"attributes":{
"product.daysAvailable":[
"0"
],
"sku.activePrice":[
"119.000000"
],
"product.repositoryName":[
"ProductCatalog"
],
"product.longDescription":[
"This watch is great for all around use. It is water resistant to up to 165 feet. The stainless steel casing will allow long use and you will never forget that birthday either, as it also keeps the date. "
],
"product.priceRange":[
"$110.00 - $119.99"
],
"product.displayName":[
"Analog Watch"
],
"sku.onSale":[
"0"
],
"product.category":[
"For Him"
],
"product.dateAvailable":[
"1414390489000"
],
"product.description":[
"Stylish analog chonograph watch"
],
"product.primaryThumbImageURL":[
"/file/cloudlakeimages/products/full/ACC_AnalogWatch_full.jpg"
],
"product.language":[
"English"
],
"common.id":[
"sku-xsku5016..xprod1004.en__US"
],
"sku.url":[
"atgrep:/ProductCatalog/sku/xsku5016?_product=xprod1004&locale=en_US"
],
"product.creationDate":[
"1414390489000"
],
"parentCategory.displayName":[
"For Him"
],
"sku.repositoryId":[
"xsku5016"
],
"product.baseUrl":[
"atgrep:/ProductCatalog/sku/xsku5016"
],
"product.primaryLargeImageURL":[
"/file/cloudlakeimages/products/full/ACC_AnalogWatch_full.jpg"
],
"sku.baseUrl":[
"atgrep:/ProductCatalog/sku/xsku5016"
],
"sku.displayName":[
"Brushed Steel Analog Watch"
],
"product.listPrice":[
"119.000000"
],
"product.primaryFullImageURL":[
"/ccstore/v1/images/?source=/file/cloudlakeimages/products/full/ACC_AnalogWatch_full.jpg"
],
"DGraph.WhyDidItMatch":[
"product.active: 1",
"product.description: Stylish analog chonograph watch (Substring/Phrase)",
"product.displayName: Analog Watch (Substring/Phrase)",
"sku.displayName: Brushed Steel Analog Watch (Substring/Phrase)"
],
"sku.type":[
"sku"
],
"product.repositoryId":[
"xprod1004"
],
"sku.listPrice":[
"119.000000"
],
"product.url":[
"atgrep:/ProductCatalog/sku/xsku5016?_product=xprod1004&locale=en_US"
],
"product.primarySmallImageURL":[
"/file/cloudlakeimages/products/full/ACC_AnalogWatch_full.jpg"
],
"sku.creationDate":[
"1414390488000"
],
"product.primaryMediumImageURL":[
"/file/cloudlakeimages/products/full/ACC_AnalogWatch_full.jpg"
],
"product.active":[
"1"
]
}
},
{
"@class":"com.endeca.infront.cartridge.model.Record",
"detailsAction":{
"contentPath":"/recorddetails",
"@class":"com.endeca.infront.cartridge.model.RecordAction",
"siteRootPath":"/services",
"label":null,
"recordState":"?R=sku-xsku5015..xprod1004.en__US"
},
"records":null,
"numRecords":0,
"attributes":{
"product.daysAvailable":[
"0"
],
"sku.activePrice":[
"249.000000"
],
"product.repositoryName":[
"ProductCatalog"
],
"product.longDescription":[
"This watch is great for all around use. It is water resistant to up to 165 feet. The stainless steel casing will allow long use and you will never forget that birthday either, as it also keeps the date. "
],
"product.priceRange":[
"$240.00 - $249.99"
],
"product.displayName":[
"Analog Watch"
],
"sku.onSale":[
"0"
],
"product.category":[
"For Him"
],
"product.dateAvailable":[
"1414390489000"
],
"product.description":[
"Stylish analog chonograph watch"
],
"product.primaryThumbImageURL":[
"/file/cloudlakeimages/products/full/ACC_AnalogWatch_full.jpg"
],
"product.language":[
"English"
],
"common.id":[
"sku-xsku5015..xprod1004.en__US"
],
"sku.url":[
"atgrep:/ProductCatalog/sku/xsku5015?_product=xprod1004&locale=en_US"
],
"product.creationDate":[
"1414390489000"
],
"parentCategory.displayName":[
"For Him"
],
"sku.repositoryId":[
"xsku5015"
],
"product.baseUrl":[
"atgrep:/ProductCatalog/sku/xsku5015"
],
"product.primaryLargeImageURL":[
"/file/cloudlakeimages/products/full/ACC_AnalogWatch_full.jpg"
],
"sku.baseUrl":[
"atgrep:/ProductCatalog/sku/xsku5015"
],
"sku.displayName":[
"Silver Plated Analog Watch"
],
"product.listPrice":[
"119.000000"
],
"product.primaryFullImageURL":[
"/ccstore/v1/images/?source=/file/cloudlakeimages/products/full/ACC_AnalogWatch_full.jpg"
],
"DGraph.WhyDidItMatch":[
"product.active: 1",
"product.description: Stylish analog chonograph watch (Substring/Phrase)",
"product.displayName: Analog Watch (Substring/Phrase)",
"sku.displayName: Silver Plated Analog Watch (Substring/Phrase)"
],
"sku.type":[
"sku"
],
"product.repositoryId":[
"xprod1004"
],
"sku.listPrice":[
"249.000000"
],
"product.url":[
"atgrep:/ProductCatalog/sku/xsku5015?_product=xprod1004&locale=en_US"
],
"product.primarySmallImageURL":[
"/file/cloudlakeimages/products/full/ACC_AnalogWatch_full.jpg"
],
"sku.creationDate":[
"1414390488000"
],
"product.primaryMediumImageURL":[
"/file/cloudlakeimages/products/full/ACC_AnalogWatch_full.jpg"
],
"product.active":[
"1"
]
}
},
{
"@class":"com.endeca.infront.cartridge.model.Record",
"detailsAction":{
"contentPath":"/recorddetails",
"@class":"com.endeca.infront.cartridge.model.RecordAction",
"siteRootPath":"/services",
"label":null,
"recordState":"?R=sku-xsku5014..xprod1004.en__US"
},
"records":null,
"numRecords":0,
"attributes":{
"product.daysAvailable":[
"0"
],
"sku.activePrice":[
"495.000000"
],
"product.repositoryName":[
"ProductCatalog"
],
"product.longDescription":[
"This watch is great for all around use. It is water resistant to up to 165 feet. The stainless steel casing will allow long use and you will never forget that birthday either, as it also keeps the date. "
],
"product.priceRange":[
"$490.00 - $499.99"
],
"product.displayName":[
"Analog Watch"
],
"sku.onSale":[
"0"
],
"product.category":[
"For Him"
],
"product.dateAvailable":[
"1414390489000"
],
"product.description":[
"Stylish analog chonograph watch"
],
"product.primaryThumbImageURL":[
"/file/cloudlakeimages/products/full/ACC_AnalogWatch_full.jpg"
],
"product.language":[
"English"
],
"common.id":[
"sku-xsku5014..xprod1004.en__US"
],
"sku.url":[
"atgrep:/ProductCatalog/sku/xsku5014?_product=xprod1004&locale=en_US"
],
"product.creationDate":[
"1414390489000"
],
"parentCategory.displayName":[
"For Him"
],
"sku.repositoryId":[
"xsku5014"
],
"product.baseUrl":[
"atgrep:/ProductCatalog/sku/xsku5014"
],
"product.primaryLargeImageURL":[
"/file/cloudlakeimages/products/full/ACC_AnalogWatch_full.jpg"
],
"sku.baseUrl":[
"atgrep:/ProductCatalog/sku/xsku5014"
],
"sku.displayName":[
"Titanium Analog Watch"
],
"product.listPrice":[
"119.000000"
],
"product.primaryFullImageURL":[
"/ccstore/v1/images/?source=/file/cloudlakeimages/products/full/ACC_AnalogWatch_full.jpg"
],
"DGraph.WhyDidItMatch":[
"product.active: 1",
"product.description: Stylish analog chonograph watch (Substring/Phrase)",
"product.displayName: Analog Watch (Substring/Phrase)",
"sku.displayName: Titanium Analog Watch (Substring/Phrase)"
],
"sku.type":[
"sku"
],
"product.repositoryId":[
"xprod1004"
],
"sku.listPrice":[
"495.000000"
],
"product.url":[
"atgrep:/ProductCatalog/sku/xsku5014?_product=xprod1004&locale=en_US"
],
"product.primarySmallImageURL":[
"/file/cloudlakeimages/products/full/ACC_AnalogWatch_full.jpg"
],
"sku.creationDate":[
"1414390488000"
],
"product.primaryMediumImageURL":[
"/file/cloudlakeimages/products/full/ACC_AnalogWatch_full.jpg"
],
"product.active":[
"1"
]
}
}
],
"numRecords":3,
"attributes":{
"common.id":[
"sku-xsku5016..xprod1004.en__US"
],
"sku.maxActivePrice":[
"495.000000"
],
"sku.minActivePrice":[
"119.000000"
]
}
}
],
"@type":"ResultsList",
"firstRecNum":1,
"precomputedSorts":[
],
"recsPerPage":12
},
"endeca:contentPath":"/guidedsearch",
"navigation":{
"navigation":[
{
"@type":"RefinementMenu",
"displayName":"Price Range",
"name":"product.priceRange",
"ancestors":[
{
"contentPath":"/guidedsearch",
"@class":"com.endeca.infront.cartridge.model.Ancestor",
"navigationState":"?N=1283845899&Nrpp=12&Ntk=product.active%7C&Ntt=1%7Canalog*",
"siteRootPath":"/services",
"label":"$0.00 - $999.99",
"properties":{
"DGraph.Spec":"r0-1000",
"dimval.prop.displayName_en_US":"$0.00 - $999.99",
"dimval.match_type":"range",
"dimval.range.comparison_type":"decimal"
}
}
],
"dimensionName":"product.priceRange",
"whyPrecedenceRuleFired":null,
"refinements":[
{
"contentPath":"/guidedsearch",
"@class":"com.endeca.infront.cartridge.model.Refinement",
"navigationState":"?N=1104216635&Nrpp=12&Ntk=product.active%7C&Ntt=1%7Canalog*",
"siteRootPath":"/services",
"count":1,
"label":"$100.00 - $199.99",
"properties":{
"DGraph.Spec":"r100-200",
"dimval.prop.displayName_en_US":"$100.00 - $199.99",
"dimval.match_type":"range",
"dimval.range.comparison_type":"decimal"
},
"multiSelect":false
},
{
"contentPath":"/guidedsearch",
"@class":"com.endeca.infront.cartridge.model.Refinement",
"navigationState":"?N=3285666269&Nrpp=12&Ntk=product.active%7C&Ntt=1%7Canalog*",
"siteRootPath":"/services",
"count":1,
"label":"$200.00 - $299.99",
"properties":{
"DGraph.Spec":"r200-300",
"dimval.prop.displayName_en_US":"$200.00 - $299.99",
"dimval.match_type":"range",
"dimval.range.comparison_type":"decimal"
},
"multiSelect":false
},
{
"contentPath":"/guidedsearch",
"@class":"com.endeca.infront.cartridge.model.Refinement",
"navigationState":"?N=3971656764&Nrpp=12&Ntk=product.active%7C&Ntt=1%7Canalog*",
"siteRootPath":"/services",
"count":1,
"label":"$400.00 - $499.99",
"properties":{
"DGraph.Spec":"r400-500",
"dimval.prop.displayName_en_US":"$400.00 - $499.99",
"dimval.match_type":"range",
"dimval.range.comparison_type":"decimal"
},
"multiSelect":false
}
],
"multiSelect":false
}
],
"@type":"NavigationContainer"
},
"searchAdjustments":{
"@type":"SearchAdjustments",
"originalTerms":[
"1",
"analog*"
]
},
"@type":"GuidedSearchService",
"name":"Guided Search Service",
"endeca:siteRootPath":"/services",
"atg:currentSiteProductionURL":null,
"zones":{
"offset":0,
"@type":"ContentSlotList",
"recordsPerPage":12
},
"breadcrumbs":{
"rangeFilterCrumbs":[
],
"searchCrumbs":[
{
"removeAction":{
"contentPath":"/guidedsearch",
"@class":"com.endeca.infront.cartridge.model.NavigationAction",
"navigationState":"?Nrpp=12&Ntt=analog*",
"siteRootPath":"/services",
"label":null
},
"@class":"com.endeca.infront.cartridge.model.SearchBreadcrumb",
"correctedTerms":null,
"terms":"1",
"key":"product.active",
"matchMode":"allpartial"
},
{
"removeAction":{
"contentPath":"/guidedsearch",
"@class":"com.endeca.infront.cartridge.model.NavigationAction",
"navigationState":"?Nrpp=12&Ntk=product.active&Ntt=1",
"siteRootPath":"/services",
"label":null
},
"@class":"com.endeca.infront.cartridge.model.SearchBreadcrumb",
"correctedTerms":null,
"terms":"analog*",
"key":"All",
"matchMode":"allpartial"
}
],
"geoFilterCrumb":null,
"@type":"Breadcrumbs",
"removeAllAction":{
"contentPath":"/guidedsearch",
"@class":"com.endeca.infront.cartridge.model.NavigationAction",
"navigationState":"",
"siteRootPath":"/services",
"label":null
},
"refinementCrumbs":[
]
}
}Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code