/
Recommendation API
Recommendation API
Mitchell Kresca (Deactivated)
Jonathan Morales
Joanna Giemzik
Owned by Mitchell Kresca (Deactivated)
Note: Please ensure tracking is first setup on your site before implementing recommendations - Event Tracking API
Overview
The Hawksearch Recommendation Service provides online retailers and publishers the ability to drive a rich, compelling user experience by presenting products to users based on various strategies. This experience drives visitors to the products that they are seeking faster on your site leading to an increase in conversions.
Typically Hawksearch Recommendations is called using a client side call. However, there may be business use cases that require a server side call to retrieve recommendations, i.e. broadcast email. This document describes how to to call the Recommendations REST API to retrieve Recommendations.
Recommendation URLs
Development
https://recs-dev.hawksearch.net/api/recommendation/v2/
Test
https://recs-test.hawksearch.net/api/recommendation/v2/
Production
https://recs-na.hawksearch.com/api/recommendation/v2/
Contents
Recommendation API Methods
Requesting Product Recommendation Widgets
Recommendations Widgets are usually returned as html, and custom CSS definitions are utilized to stylize the returned widget.
Widgets can also be requested to be returned as json instead of html, utilizing the Hawk Search REST API, with all the display logic residing (applied html and css) within the user interface code.
Following are sample URLs which represent REST API calls to available Recommendation environments. The context of the recommendation is passed in the body of the API call.
Request
Endpoint | Method | Header Key |
|---|---|---|
| api/recommendation/v2/getwidgetitems | POST | Content-Type: application/json |
Parameters
| Name | Description | |
|---|---|---|
| visitId | This should correspond to the visit id stored in the cookie for the user. | |
| visitorId | This should correspond to the visitor id stored in the cookie for the user. | |
| clientGuid | This should correspond to the Tracking Key for your engine. (To lookup the Tracking Key for your account, please look in the Hawksearch workbench under Admin >> Account Info.) | |
| enablePreview | This indicates whether preview has been enabled in the admin for that widget. | |
| widgetUids | List of recommendations guids to return. | |
| widgetGuid | this value corresponds to the widgetGuid found in the Hawksearch workbench | |
| uniqueid | Optional. This corresponds to the uniqueid of an item that a user is viewing on the page. ie a product detail page. This is optional and if not applicable (ie homepage) can be null. | |
| contextProperties | All information will be passed into customProperites. | |
| extendedCustomProperties | A Dictionary of customProperies objects that is passed into HawkSearch.Context.Custom object on the page should be passed in here. | |
| customProperties | All information that is passed into HawkSearch.Context.Custom object on the page should be passed in here. | |
| landingPageUrl | If you are on a landing page that was set up in Hawksearch, this will be the corresponding landing page url of that page. | |
| renderHTML | If marked as true, Widget HTML will be returned as set in the admin. If false, items will be returned as JSON. | |
| indexName | Available for Hawksearch V4.0 API only. The name of the index against which the recommendation search must be performed. | |
| query | Available for Hawksearch V4.0 API only. Use this to perform recommendation searches on one or more specific fields without needing to create facets for them. For examples, see Field-specific Search | |
Sample Request (When HTML Is Requested)
{
"visitId":"38955389-5006-4ec0-ae4d-d9471929feec",
"visitorId":"cc482558-72eb-4be4-afe7-4768dc6ecf48",
"clientGuid":"23d1b7dcba6f4486af76ebd26875f3c5",
"enablePreview":true,
"widgetUids":[
{
"widgetGuid":"91afc887-ddfc-4067-a03b-b4d2bfbc5d32",
"uniqueid":655
}
],
"contextProperties":{
"uniqueid":"655"
},
"customProperties":{
},
"landingPageUrl":"",
"renderHTML":true
}
Sample Request (When Items Returned as JSON)
{
"visitId":"38955389-5006-4ec0-ae4d-d9471929feec",
"visitorId":"cc482558-72eb-4be4-afe7-4768dc6ecf48",
"clientGuid":"23d1b7dcba6f4486af76ebd26875f3c5",
"enablePreview":true,
"widgetUids":[
{
"widgetGuid":"91afc887-ddfc-4067-a03b-b4d2bfbc5d32",
"uniqueid":655
}
],
"contextProperties":{
"uniqueid":"655"
},
"customProperties":{
},
"landingPageUrl":"",
"renderHTML":false
}
Sample Request (Multiple Visitor Targets)
{
"clientGuid": "51c020f7109043e8925e833c10c61c4f",
"contextProperties": {
"uniqueId": "bc_27623"
},
"extendedCustomProperties": {
"hawkcustom": [
"custid:123",
"isb2c:1"
]
},
"enablePreview": false,
"landingPageUrl": "",
"renderHTML": false,
"visitId": "545d36fc-b6f0-4289-86b5-3f4d2614a089",
"visitorId": "c3b63dea-2126-4c7e-8c91-65a429f5d825",
"widgetUids": [
{
"widgetGuid": "d431c981-93ba-4e91-9a0e-5492bf99d0a0"
}
]
}
Response
Structure
| Object | Descripion |
|---|---|
| widgetItems | Array of requested widgets. |
| recommendationItems | Array of items returned . (populated when renderHTMl is set to false in the request body) Within the custom object you will see the fields that map directly with the data fields as long as the corresponding field is marked as Include In Results within the admin. All Other Objects are used for Mappings within the Hawksearch admin. These Mappings are also set up within the Hawksearch admin |
| html | String of HTML populated with Item information that ties in with the HTML template set up in the Hawksearch admin. (populated when renderHTMl is set to true in the request body) |
| widgetGuid | Guid of of the corresponding widget you are requesting. |
| widgetName | String of Name of of the corresponding widget you are requesting. |
| widgetTitle | String of Title of of the corresponding widget you are requesting. |
| widgetCssClass | String of CSS class of of the corresponding widget you are requesting. |
| isCarousel | Boolean indicating if it is marked as a carousel. |
| carouselData | Object of carousel data. (we use slick JS as a standard so the object closely matches Slick JS objects) |
| isVertical | Boolean indicating if the widget is marked as vertical. |
| itemsCount | Integer for the total count of items that can be returned in the widget. |
Sample Response (When HTML is Rendered)
{
"widgetItems":[
{
"recommendationItems":[
],
"html":"<h4>Our Picks for You</h4>\r\n<div class=\"hawk-recommendation-list itemList\">\r\n <div class=\"hawk-recommendation-item itemWrapper hawk-itemWrapper\" data-hawk-modelname=\"Featured Items\" data-hawk-modeltype=\"FeaturedItems\" data-hawk-modelguid=\"6627b0a6-b213-48c3-9d12-edba41f207be\">\r\n <a href=\"http://demo-dev.hawksearch.net/details.aspx?itemid=Item_72341\" class=\"itemLink\" onmousedown=\"HawkSearch.Recommender.Track(this,'Item_72341',1)\">\r\n <img src=\"https://dev.hawksearch.net/assets/1/14/DimThumbnail/{EDD68457-FDFD-4FD5-9E16-675B3817B07F}.jpg\"> \r\n </a> \r\n <h3 class=\"itemTitle\">\r\n <em style=\"display:block\">Industrial Revolution</em>\r\n <a href=\"http://demo-dev.hawksearch.net/details.aspx?itemid=Item_72341\" onmousedown=\"HawkSearch.Recommender.Track(this,'Item_72341',1)\">\r\n Storm Proof Matches\r\n </a> \r\n </h3>\r\n <p class=\"itemDesc\">\r\n </p>\r\n <p class=\"itemPrice\">\r\n $4.99 \r\n </p>\r\n <div class=\"clearfix\">\r\n <div class=\"hawk-listingRating\">\r\n <span class=\"hawk-rating hawk-rated5\" data-ratingvalue='5.0'></span>\r\n <span class=\"hawk-ratingDecimal\">\r\n 5.0\r\n </span> \r\n </div> \r\n </div>\r\n </div> \r\n <div class=\"hawk-recommendation-item itemWrapper hawk-itemWrapper\" data-hawk-modelname=\"Featured Items\" data-hawk-modeltype=\"FeaturedItems\" data-hawk-modelguid=\"6627b0a6-b213-48c3-9d12-edba41f207be\">\r\n <a href=\"http://demo-dev.hawksearch.net/details.aspx?itemid=Item_136824\" class=\"itemLink\" onmousedown=\"HawkSearch.Recommender.Track(this,'Item_136824',2)\">\r\n <img src=\"https://dev.hawksearch.net/assets/1/14/DimThumbnail/8418303P707.jpg\"> \r\n </a> \r\n <h3 class=\"itemTitle\">\r\n <em style=\"display:block\">Spyder</em>\r\n <a href=\"http://demo-dev.hawksearch.net/details.aspx?itemid=Item_136824\" onmousedown=\"HawkSearch.Recommender.Track(this,'Item_136824',2)\">\r\n Women's Melody Full Zip Mid WT Core Sweater Vest\r\n </a> \r\n </h3>\r\n <p class=\"itemDesc\">\r\n </p>\r\n <p class=\"itemPrice\">\r\n $99.00 \r\n </p>\r\n <div class=\"clearfix\">\r\n <div class=\"hawk-listingRating\">\r\n <span class=\"hawk-rating hawk-rated5\" data-ratingvalue='5.0'></span>\r\n <span class=\"hawk-ratingDecimal\">\r\n 5.0\r\n </span> \r\n </div> \r\n </div>\r\n </div> \r\n <div class=\"hawk-recommendation-item itemWrapper hawk-itemWrapper\" data-hawk-modelname=\"Best Sellers\" data-hawk-modeltype=\"BestSellers\" data-hawk-modelguid=\"d6bac016-c51f-4542-971d-2df859345276\">\r\n <a href=\"http://demo-dev.hawksearch.net/details.aspx?itemid=Item_154741\" class=\"itemLink\" onmousedown=\"HawkSearch.Recommender.Track(this,'Item_154741',3)\">\r\n <img src=\"https://dev.hawksearch.net/assets/1/14/DimThumbnail/Quick-Clava-JR-Fleece-Knit-Hat-Black-Cyan.jpg\"> \r\n </a> \r\n <h3 class=\"itemTitle\">\r\n <em style=\"display:block\"></em>\r\n <a href=\"http://demo-dev.hawksearch.net/details.aspx?itemid=Item_154741\" onmousedown=\"HawkSearch.Recommender.Track(this,'Item_154741',3)\">\r\n Quick Clava JR Fleece Knit Hat 3394\r\n </a> \r\n </h3>\r\n <p class=\"itemDesc\">\r\n </p>\r\n <p class=\"itemPrice\">\r\n $19.99 \r\n </p>\r\n <div class=\"clearfix\">\r\n <div class=\"hawk-listingRating\">\r\n <span class=\"hawk-rating hawk-rated2\" data-ratingvalue='1.5'></span>\r\n <span class=\"hawk-ratingDecimal\">\r\n 1.5\r\n </span> \r\n </div> \r\n </div>\r\n </div> \r\n <div class=\"hawk-recommendation-item itemWrapper hawk-itemWrapper\" data-hawk-modelname=\"Best Sellers\" data-hawk-modeltype=\"BestSellers\" data-hawk-modelguid=\"d6bac016-c51f-4542-971d-2df859345276\">\r\n <a href=\"http://demo-dev.hawksearch.net/details.aspx?itemid=Item_106565\" class=\"itemLink\" onmousedown=\"HawkSearch.Recommender.Track(this,'Item_106565',4)\">\r\n <img src=\"https://dev.hawksearch.net/assets/1/14/DimThumbnail/White-Sierra-Men-Trabagon-Rain-Pant-black.jpg\"> \r\n </a> \r\n <h3 class=\"itemTitle\">\r\n <em style=\"display:block\">White Sierra</em>\r\n <a href=\"http://demo-dev.hawksearch.net/details.aspx?itemid=Item_106565\" onmousedown=\"HawkSearch.Recommender.Track(this,'Item_106565',4)\">\r\n Men's Trabagon Rain Pant\r\n </a> \r\n </h3>\r\n <p class=\"itemDesc\">\r\n </p>\r\n <p class=\"itemPrice\">\r\n <strike>$45.00</strike>\t\t\t\r\n <span class=\"red\">$34.97</span>\r\n </p>\r\n <div class=\"clearfix\">\r\n <div class=\"hawk-listingRating\">\r\n <span class=\"hawk-rating hawk-rated0\" data-ratingvalue='0.0'></span>\r\n <span class=\"hawk-ratingDecimal\">\r\n 0.0\r\n </span> \r\n </div> \r\n </div>\r\n </div> \r\n <div class=\"hawk-recommendation-item itemWrapper hawk-itemWrapper\" data-hawk-modelname=\"Most Popular\" data-hawk-modeltype=\"MostPopular\" data-hawk-modelguid=\"c683ce96-fb5c-48bf-b439-5e2ae7998d74\">\r\n <a href=\"http://demo-dev.hawksearch.net/details.aspx?itemid=Item_72232\" class=\"itemLink\" onmousedown=\"HawkSearch.Recommender.Track(this,'Item_72232',5)\">\r\n <img src=\"https://dev.hawksearch.net/assets/1/14/DimThumbnail/North-Face-mens-Apex-Bionic-Jacket-Black-Heather_Black.jpg\"> \r\n </a> \r\n <h3 class=\"itemTitle\">\r\n <em style=\"display:block\">The North Face</em>\r\n <a href=\"http://demo-dev.hawksearch.net/details.aspx?itemid=Item_72232\" onmousedown=\"HawkSearch.Recommender.Track(this,'Item_72232',5)\">\r\n Men's Apex Bionic Jacket\r\n </a> \r\n </h3>\r\n <p class=\"itemDesc\">\r\n </p>\r\n <p class=\"itemPrice\">\r\n <strike>$149.00</strike>\t\t\t\r\n <span class=\"red\">$110.97</span>\r\n </p>\r\n <div class=\"clearfix\">\r\n <div class=\"hawk-listingRating\">\r\n <span class=\"hawk-rating hawk-rated1\" data-ratingvalue='1.0'></span>\r\n <span class=\"hawk-ratingDecimal\">\r\n 1.0\r\n </span> \r\n </div> \r\n </div>\r\n </div> \r\n <div class=\"hawk-recommendation-item itemWrapper hawk-itemWrapper\" data-hawk-modelname=\"Most Popular\" data-hawk-modeltype=\"MostPopular\" data-hawk-modelguid=\"c683ce96-fb5c-48bf-b439-5e2ae7998d74\">\r\n <a href=\"http://demo-dev.hawksearch.net/details.aspx?itemid=Item_72708\" class=\"itemLink\" onmousedown=\"HawkSearch.Recommender.Track(this,'Item_72708',6)\">\r\n <img src=\"https://dev.hawksearch.net/assets/1/14/DimThumbnail/{32611B69-981D-4028-B50C-AFE07D048767}.jpg\"> \r\n </a> \r\n <h3 class=\"itemTitle\">\r\n <em style=\"display:block\">Black Diamond Equipment</em>\r\n <a href=\"http://demo-dev.hawksearch.net/details.aspx?itemid=Item_72708\" onmousedown=\"HawkSearch.Recommender.Track(this,'Item_72708',6)\">\r\n 18mm Nylon Runner 30cm\r\n </a> \r\n </h3>\r\n <p class=\"itemDesc\">\r\n </p>\r\n <p class=\"itemPrice\">\r\n $4.50 \r\n </p>\r\n <div class=\"clearfix\">\r\n <div class=\"hawk-listingRating\">\r\n <span class=\"hawk-rating hawk-rated2\" data-ratingvalue='1.5'></span>\r\n <span class=\"hawk-ratingDecimal\">\r\n 1.5\r\n </span> \r\n </div> \r\n </div>\r\n </div> \r\n</div>",
"widgetGuid":"ac843f01-3391-41ee-9db2-36929a021622",
"widgetName":"Our Picks for You",
"widgeTitle":"Our Picks for You",
"widgetCssClass":"",
"isCarousel":true,
"carouselData":{
"showNextPrevButtons":true,
"autoRotate":false,
"autoRotateSpeed":3000,
"animationSpeed":750,
"nofVisible":4,
"isCircular":true,
"scrollNumber":4,
"showDots":true,
"enableResponsive":true,
"responseiveConfig":"[\r\n {\r\n \"breakpoint\": 1024,\r\n \"settings\": {\r\n \"slidesToShow\": 4,\r\n \"slidesToScroll\": 4 \r\n }\r\n },\r\n {\r\n \"breakpoint\": 860,\r\n \"settings\": {\r\n \"slidesToShow\": 4,\r\n \"slidesToScroll\": 4 \r\n }\r\n },\r\n {\r\n \"breakpoint\": 600,\r\n \"settings\": {\r\n \"slidesToShow\": 3,\r\n \"slidesToScroll\": 3 \r\n }\r\n },\r\n {\r\n \"breakpoint\": 768,\r\n \"settings\": {\r\n \"slidesToShow\": 3,\r\n \"slidesToScroll\": 3 \r\n }\r\n }, \r\n {\r\n \"breakpoint\": 480,\r\n \"settings\": {\r\n \"slidesToShow\": 2,\r\n \"slidesToScroll\": 2\r\n }\r\n },\r\n {\r\n \"breakpoint\": 240,\r\n \"settings\": {\r\n \"slidesToShow\": 1,\r\n \"slidesToScroll\": 1\r\n }\r\n }\r\n]"
},
"isVertical":false,
"itemsCount":12
}
],
"isSuccess":true,
"requestId":"4a9937b9-e68a-486d-a613-8fb66afd65e7"
}
Sample Response (When Items Returned as JSON)
{
"widgetItems":[
{
"recommendationItems":[
{
"brand":"Eagle Creek",
"price":"12.9500",
"imageUrl":"https://dev.hawksearch.net/assets/1/14/DimThumbnail/Packit_Sac_Large_Red.jpg",
"isOnSale":false,
"salePrice":"12.9500",
"bestFragment":null,
"color":"Black",
"url":"http://demo-dev.hawksearch.net/details.aspx?itemid=Item_72450",
"id":"Item_72450",
"imageAlt":"Packit_Sac_Large_Red",
"imageOverAltTag":null,
"imageOverUrl":null,
"itemName":"Pack-it Sac Large",
"maxPrice":null,
"maxSalePrice":null,
"minPrice":null,
"minSalePrice":null,
"postDate":null,
"rating":"+0000000000000005.0000",
"shortDescription":null,
"sku":null,
"itemIndex":1,
"modelName":"Featured Items",
"modelType":"FeaturedItems",
"modelGuid":"6627b0a6-b213-48c3-9d12-edba41f207be",
"custom":{
"department_nest":"1|Run & Fitness",
"subdepartmentpath":"1|Specials",
"itemtypeid":"3.0000",
"listingasseturl":null,
"no_of_balls_per_plate":null,
"rating":"+0000000000000005.0000",
"ratingCopy":null,
"ratingCopy2":null,
"ratingrange":"5.0000",
"sectioncategory":null,
...
}
},
{
"brand":"Marmot",
"price":"119.0000",
"imageUrl":"https://dev.hawksearch.net/assets/1/14/DimThumbnail/Trestles-30-Long-X-Wide-Moss-Green-Gulch.jpg",
"isOnSale":true,
"salePrice":"94.9700",
"bestFragment":null,
"color":"Green",
"url":"http://demo-dev.hawksearch.net/details.aspx?itemid=Item_170730",
"id":"Item_170730",
"imageAlt":"Trestles-30-Long-X-Wide-Moss-Green-Gulch",
"imageOverAltTag":null,
"imageOverUrl":null,
"itemName":"Trestle 30 X Wide",
"maxPrice":null,
"maxSalePrice":null,
"minPrice":null,
"minSalePrice":null,
"postDate":null,
"rating":"+0000000000000005.0000",
"shortDescription":null,
"sku":null,
"itemIndex":2,
"modelName":"Featured Items",
"modelType":"FeaturedItems",
"modelGuid":"6627b0a6-b213-48c3-9d12-edba41f207be",
"custom":{
"department_nest":"1|Specials",
"subdepartmentpath":"1|Sale",
"itemtypeid":"3.0000",
"listingasseturl":null,
"no_of_balls_per_plate":null,
"rating":"+0000000000000005.0000",
"ratingCopy":null,
"ratingCopy2":null,
"ratingrange":"5.0000",
...
}
},
{
"brand":"White Sierra",
"price":"45.0000",
"imageUrl":"https://dev.hawksearch.net/assets/1/14/DimThumbnail/White-Sierra-Men-Trabagon-Rain-Pant-black.jpg",
"isOnSale":true,
"salePrice":"34.9700",
"bestFragment":null,
"color":"Black",
"url":"http://demo-dev.hawksearch.net/details.aspx?itemid=Item_106565",
"id":"Item_106565",
"imageAlt":"Trabagon",
"imageOverAltTag":null,
"imageOverUrl":null,
"itemName":"Men's Trabagon Rain Pant",
"maxPrice":null,
"maxSalePrice":null,
"minPrice":null,
"minSalePrice":null,
"postDate":null,
"rating":"+0000000000000000.0000",
"shortDescription":null,
"sku":null,
"itemIndex":4,
"modelName":"Best Sellers",
"modelType":"BestSellers",
"modelGuid":"d6bac016-c51f-4542-971d-2df859345276",
"custom":{
"department_nest":"1|Men",
"subdepartmentpath":"1|Sale",
"itemtypeid":"3.0000",
"listingasseturl":null,
"no_of_balls_per_plate":null,
"rating":"+0000000000000000.0000",
...
}
},
{
"brand":"The North Face",
"price":"149.0000",
"imageUrl":"https://dev.hawksearch.net/assets/1/14/DimThumbnail/North-Face-mens-Apex-Bionic-Jacket-Black-Heather_Black.jpg",
"isOnSale":true,
"salePrice":"110.9700",
"bestFragment":null,
"color":"Black",
"url":"http://demo-dev.hawksearch.net/details.aspx?itemid=Item_72232",
"id":"Item_72232",
"imageAlt":"North-Face-mens-Apex-Bionic-Jacket-Black-Heather_Black",
"imageOverAltTag":null,
"imageOverUrl":null,
"itemName":"Men's Apex Bionic Jacket",
"maxPrice":null,
"maxSalePrice":null,
"minPrice":null,
"minSalePrice":null,
"postDate":null,
"rating":"+0000000000000001.0000",
"shortDescription":null,
"sku":null,
"itemIndex":5,
"modelName":"Most Popular",
"modelType":"MostPopular",
"modelGuid":"c683ce96-fb5c-48bf-b439-5e2ae7998d74",
"custom":{
"department_nest":"1|Specials",
"subdepartmentpath":"1|Men",
"itemtypeid":"3.0000",
"listingasseturl":null,
"no_of_balls_per_plate":null,
"rating":"+0000000000000001.0000",
"ratingCopy":null,
"ratingCopy2":null,
"ratingrange":"1.0000",
...
}
},
{
"brand":"Black Diamond Equipment",
"price":"4.5000",
"imageUrl":"https://dev.hawksearch.net/assets/1/14/DimThumbnail/{32611B69-981D-4028-B50C-AFE07D048767}.jpg",
"isOnSale":false,
"salePrice":"4.5000",
"bestFragment":null,
"color":null,
"url":"http://demo-dev.hawksearch.net/details.aspx?itemid=Item_72708",
"id":"Item_72708",
"imageAlt":"6722",
"imageOverAltTag":null,
"imageOverUrl":null,
"itemName":"18mm Nylon Runner 30cm",
"maxPrice":null,
"maxSalePrice":null,
"minPrice":null,
"minSalePrice":null,
"postDate":null,
"rating":"+0000000000000001.5000",
"shortDescription":null,
"sku":null,
"itemIndex":6,
"modelName":"Most Popular",
"modelType":"MostPopular",
"modelGuid":"c683ce96-fb5c-48bf-b439-5e2ae7998d74",
"custom":{
"subdepartmentpath":"1|Climb",
"itemtypeid":"3.0000",
"listingasseturl":null,
"no_of_balls_per_plate":null,
"rating":"+0000000000000001.5000",
"ratingCopy":null,
"ratingCopy2":null,
"ratingrange":"1.5000",
...
}
}
],
"html":"",
"widgetGuid":"ac843f01-3391-41ee-9db2-36929a021622",
"widgetName":"Our Picks for You",
"widgeTitle":"Our Picks for You",
"widgetCssClass":"",
"isCarousel":true,
"carouselData":{
"showNextPrevButtons":true,
"autoRotate":false,
"autoRotateSpeed":3000,
"animationSpeed":750,
"nofVisible":4,
"isCircular":true,
"scrollNumber":4,
"showDots":true,
"enableResponsive":true,
"responseiveConfig":"[\r\n {\r\n \"breakpoint\": 1024,\r\n \"settings\": {\r\n \"slidesToShow\": 4,\r\n \"slidesToScroll\": 4 \r\n }\r\n },\r\n {\r\n \"breakpoint\": 860,\r\n \"settings\": {\r\n \"slidesToShow\": 4,\r\n \"slidesToScroll\": 4 \r\n }\r\n },\r\n {\r\n \"breakpoint\": 600,\r\n \"settings\": {\r\n \"slidesToShow\": 3,\r\n \"slidesToScroll\": 3 \r\n }\r\n },\r\n {\r\n \"breakpoint\": 768,\r\n \"settings\": {\r\n \"slidesToShow\": 3,\r\n \"slidesToScroll\": 3 \r\n }\r\n }, \r\n {\r\n \"breakpoint\": 480,\r\n \"settings\": {\r\n \"slidesToShow\": 2,\r\n \"slidesToScroll\": 2\r\n }\r\n },\r\n {\r\n \"breakpoint\": 240,\r\n \"settings\": {\r\n \"slidesToShow\": 1,\r\n \"slidesToScroll\": 1\r\n }\r\n }\r\n]"
},
"isVertical":false,
"itemsCount":12
}
],
"isSuccess":true,
"requestId":"41107256-a5a5-4317-ba8a-de5b3e90b5e1"
}
Sample Response (Multiple Visitor Targets)
{
"isSuccess": true,
"requestId": "b3d1977c-9459-41b3-9c53-2e9fb0e107be",
"widgetItems": [
{
"widgetName": "Featured Products - Test Widget",
"widgetTitle": "Featured Products",
"widgetCssClass": "",
"widgetGuid": "d431c981-93ba-4e91-9a0e-5492bf99d0a0",
"items": [
{
"brand": "John Deere",
"price": null,
"imageUrl": null,
...
"custom": {},
"customDict": {
"s2_product_line_id": "AG",
"url_detail": "/used-john-deere-640fd-x334095/",
"price_retail": "70930.0000",
"group_code": "HDRFLXDRPR",
...
}
},
{
"brand": "John Deere",
"price": null,
"imageUrl": null,
...
"custom": {},
"customDict": {
"s2_product_line_id": "AG",
"price_retail": "150410.0000",
...
}
},
{
"brand": "John Deere",
"price": null,
"imageUrl": null,
...
"custom": {},
"customDict": {
"s2_product_line_id": "CE",
"price_retail": "8000.0000",
"feature_wholegoods": "Size #1<br/>Straight Teeth",
"year": "2019",
...
}
},
{
"brand": "John Deere",
"price": null,
"imageUrl": null,
"isOnSale": false,
...
"custom": {},
"customDict": {
"s2_product_line_id": "CE",
"price_retail": "329300.0000",
"year": "2020",
...
}
}
]
}
]
}
Requesting Multiple Recommendation Widgets
Get Bulk Widget Items returns multiple recommendations for a list of widgets with SKU's. Easch bulk request can contain up to 10 widgets.
Request
Endpoint | Method | Header Key |
|---|---|---|
| api/recommendation/v2/getbulkwidgetitems | POST | Content-Type: application/json |
Parameters
| Name | Description | |
|---|---|---|
| visitId | This should correspond to the visit id stored in the cookie for the user. | |
| visitorId | This should correspond to the visitor id stored in the cookie for the user. | |
| clientGuid | This should correspond to the Tracking Key for your engine. (To lookup the Tracking Key for your account, please look in the Hawksearch workbench under Admin >> Account Info.) | |
| enablePreview | This indicates whether preview has been enabled in the admin for that widget. | |
widgets | List of recommendations widgets to return. | |
| widgetGuid | This value corresponds to the widgetGuid found in the Hawksearch workbench | |
| uniqueid | Optional. This corresponds to the uniqueid of an item that a user is viewing on the page. ie a product detail page. This is optional and if not applicable (ie homepage) can be null. | |
| contextProperties | All information that is passed into the HawkSearch.Context object on page should be passed in here. | |
| extendedCustomProperties | A Dictionary of customProperies objects that is passed into HawkSearch.Context.Custom object on the page should be passed in here. | |
| customProperties | All information that is passed into HawkSearch.Context.Custom object on the page should be passed in here. | |
| landingPageUrl | If you are on a landing page that was set up in Hawksearch, this will be the corresponding landing page url of that page. | |
widgetBatchSize | batch size of the recommendation | |
| indexName | Available for Hawksearch V4.0 API only. The name of the index against which the recommendation search must be performed. | |
| query | Available for Hawksearch V4.0 API only. Use this to perform recommendation searches on one or more specific fields without needing to create facets for them. For examples, see Field-specific Search | |
Sample Request (Same widget with multiple uniqueIds)
{
"visitId": "44324b64-973d-48ca-8c89-0ac12d4b7087",
"visitorId": "83c081f2-8492-4dee-9bbc-45946907ca60",
"clientGuid": "dfb51ea2ea1a42e4a53d4e67f7f6847b",
"enablePreview": false,
"widgetBatchSize":3,
"landingPageUrl": "",
"widgets": [
{
"widgetGuid": "AC843F01-3391-41EE-9DB2-36929A021622",
"contextProperties": {
"uniqueId": "Item_124103"
}
},
{
"widgetGuid": "AC843F01-3391-41EE-9DB2-36929A021622",
"contextProperties": {
"uniqueId": "Item_124104"
}
},
{
"widgetGuid": "AC843F01-3391-41EE-9DB2-36929A021622",
"contextProperties": {
"uniqueId": "Item_124105"
}
}
]
}
Sample Request (Different widget with same uniqueIds)
{
"visitId": "44324b64-973d-48ca-8c89-0ac12d4b7087",
"visitorId": "83c081f2-8492-4dee-9bbc-45946907ca60",
"clientGuid": "dfb51ea2ea1a42e4a53d4e67f7f6847b",
"enablePreview": false,
"widgetBatchSize":3,
"landingPageUrl": "",
"widgets": [
{
"widgetGuid": "AC843F01-3391-41EE-9DB2-36929A021622",
"contextProperties": {
"uniqueId": "Item_124103"
}
},
{
"widgetGuid": "ECAEE03B-3B9B-42B2-A645-7E7709BC120D",
"contextProperties": {
"uniqueId": "Item_124103"
}
},
{
"widgetGuid": "BDC3F609-946C-4501-8ABE-2BED63055FB6",
"contextProperties": {
"uniqueId": "Item_124103"
}
}
]
}
Sample Request (Different widget with different uniqueIds)
{
"visitId": "44324b64-973d-48ca-8c89-0ac12d4b7087",
"visitorId": "83c081f2-8492-4dee-9bbc-45946907ca60",
"clientGuid": "dfb51ea2ea1a42e4a53d4e67f7f6847b",
"enablePreview": false,
"widgetBatchSize":2,
"landingPageUrl": "",
"widgets": [
{
"widgetGuid": "AC843F01-3391-41EE-9DB2-36929A021622",
"contextProperties": {
"uniqueId": "Item_124103"
}
},
{
"widgetGuid": "9B0E3152-2FEE-4F53-B744-78BF4E9A46A3",
"contextProperties": {
"uniqueId": "Item_124104"
}
},
{
"widgetGuid": "ECAEE03B-3B9B-42B2-A645-7E7709BC120D",
"contextProperties": {
"uniqueId": "Item_124105"
}
}
]
}
Response
Sample Response (Same widget with multiple uniqueIds)
{
"widgetItems": [
{
"recommendationItems": [
{
"brand": "The North Face",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/TNF-Venture-Jacket-Moonstruck-Grey_Sedona-Sage-Grey.jpg",
"isOnSale": false,
"salePrice": "99.0000",
"bestFragment": null,
"color": "Black",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_72246",
"id": "Item_72246",
"imageAlt": "TNF-Venture-Jacket-Moonstruck-Grey_Sedona-Sage-Grey",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Men's Venture Jacket",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000004.0000",
"shortDescription": null,
"sku": null,
"itemIndex": 1,
"modelName": "Most Popular",
"modelType": "MostPopular",
"modelGuid": "7684b354-0b15-49ee-95ec-e9acff0a6f22",
"custom": {
"department_nest": "1|Men",
"subdepartmentpath": "1|Summer Sale",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "99.0000",
"rating": "+0000000000000004.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "4.0000",
...
},
"customDict": {
"department_nest": "1|Men",
"subdepartmentpath": "1|Summer Sale",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "99.0000",
"rating": "+0000000000000004.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "4.0000",
"rating_stars": null,
...
}
},
{
"brand": "The North Face",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/92222443S07.jpg",
"isOnSale": false,
"salePrice": "55.0000",
"bestFragment": null,
"color": "Black",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_124104",
"id": "Item_124104",
"imageAlt": "124104",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Youth Resolve Pant",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000005.0000",
"shortDescription": null,
"sku": null,
"itemIndex": 2,
"modelName": "Most Popular",
"modelType": "MostPopular",
"modelGuid": "7684b354-0b15-49ee-95ec-e9acff0a6f22",
"custom": {
"department_nest": "1|Kids",
"subdepartmentpath": "1|Specials",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "55.0000",
"rating": "+0000000000000005.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "5.0000",
"rating_stars": null,
"required": null,
"sectioncategory": null,
"size-property": "M",
"type": "Item",
...
},
"customDict": {
"department_nest": "1|Kids",
"subdepartmentpath": "1|Specials",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "55.0000",
"rating": "+0000000000000005.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "5.0000",
"rating_stars": null,
"required": null,
...
}
},
{
"brand": "Lowa",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/Lowa-Ferrox-GTX-Lo-Black_Grey.jpg",
"isOnSale": false,
"salePrice": "175.0000",
"bestFragment": null,
"color": "Black",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_161686",
"id": "Item_161686",
"imageAlt": "Lowa-Ferrox-GTX-Lo-Black_Grey",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Men's Ferrox GTX Lo",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000001.5000",
"shortDescription": null,
"sku": null,
"itemIndex": 3,
"modelName": "Add To Cart For Me",
"modelType": "AddToCartForMe",
"modelGuid": "6bc2b868-ec38-489e-8a84-f811059ae603",
"custom":
"department_nest": "1|Footwear",
"subdepartmentpath": "1|Specials",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "175.0000",
"rating": "+0000000000000001.5000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "1.5000",
"rating_stars": null,
"required": null,
"sectioncategory": null,
"size-property": "8.5",
...
},
"customDict": {
"department_nest": "1|Footwear",
"subdepartmentpath": "1|Specials",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "175.0000",
"rating": "+0000000000000001.5000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "1.5000",
"rating_stars": null,
"required": null,
"sectioncategory": null,
"size-property": "8.5",
...
}
},
{
"brand": "Oboz",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/Oboz-Sawtooth-Low-BDRY-Violet.jpg",
"isOnSale": false,
"salePrice": "135.0000",
"bestFragment": null,
"color": "Purple",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_145568",
"id": "Item_145568",
"imageAlt": "Oboz-Sawtooth-Low-BDRY-Violet",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Women's Sawtooth Low BDRY",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000003.0000",
"shortDescription": null,
"sku": null,
"itemIndex": 4,
"modelName": "Add To Cart For Me",
"modelType": "AddToCartForMe",
"modelGuid": "6bc2b868-ec38-489e-8a84-f811059ae603",
"custom": {
"department_nest": "1|Footwear",
"subdepartmentpath": "1|Summer Sale",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "135.0000",
"rating": "+0000000000000003.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "3.0000",
"rating_stars": null,
...
},
"customDict": {
"department_nest": "1|Footwear",
"subdepartmentpath": "1|Summer Sale",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "135.0000",
"rating": "+0000000000000003.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "3.0000",
"rating_stars": null,
"required": null,
"sectioncategory": null,
"size-property": "6",
...
}
},
{
"brand": "Keen",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/Targhee-II-Mid_Raven_Tortoise-Shell.jpg",
"isOnSale": false,
"salePrice": "135.0000",
"bestFragment": null,
"color": "Brown",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_123063",
"id": "Item_123063",
"imageAlt": "Targhee-II-Mid_Raven_Tortoise-Shell Edit Details | Clear",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Men's Targhee II Mid",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000005.0000",
"shortDescription": null,
"sku": null,
"itemIndex": 5,
"modelName": "Personalized",
"modelType": "Personalized",
"modelGuid": "3aef8a6c-c55d-47bc-ac70-7df14102b98a",
"custom": {
"department_nest": "1|Footwear",
"subdepartmentpath": "1|Specials",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "135.0000",
"rating": "+0000000000000005.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "5.0000",
"rating_stars": null,
"required": null,
"sectioncategory": null,
"size-property": "8",
...
},
"customDict": {
"department_nest": "1|Footwear",
"subdepartmentpath": "1|Specials",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "135.0000",
"rating": "+0000000000000005.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "5.0000",
"rating_stars": null,
"required": null,
"sectioncategory": null,
"size-property": "8",
...
}
},
{
"brand": "La Sportiva",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/La-Sportiva-Ultra-Raptor-Black_Yellow.jpg",
"isOnSale": false,
"salePrice": "130.0000",
"bestFragment": null,
"color": "Black",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_164653",
"id": "Item_164653",
"imageAlt": "La-Sportiva-Ultra-Raptor-Black_Yellow",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Men's Ultra Raptor",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000003.5000",
"shortDescription": null,
"sku": null,
"itemIndex": 6,
"modelName": "Personalized",
"modelType": "Personalized",
"modelGuid": "3aef8a6c-c55d-47bc-ac70-7df14102b98a",
"custom": {
"department_nest": "1|Footwear",
"subdepartmentpath": "1|Run & Fitness",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "130.0000",
"rating": "+0000000000000003.5000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "3.5000",
"rating_stars": null,
"required": null,
"sectioncategory": null,
"size-property": "43.5",
...
},
"customDict": {
"department_nest": "1|Footwear",
"subdepartmentpath": "1|Run & Fitness",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "130.0000",
"rating": "+0000000000000003.5000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "3.5000",
"rating_stars": null,
"required": null,
"sectioncategory": null,
"size-property": "43.5",
...
}
},
{
"brand": "Oboz",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/Womens-Sawtooth-Low-clover.jpg",
"isOnSale": false,
"salePrice": "110.0000",
"bestFragment": null,
"color": "Green",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_108946",
"id": "Item_108946",
"imageAlt": "Women's Sawtooth Low",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Women's Sawtooth Low",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000004.0000",
"shortDescription": null,
"sku": null,
"itemIndex": 7,
"modelName": "Also Bought",
"modelType": "AlsoBought",
"modelGuid": "aaba133b-bccb-4e6b-abbf-ae1cfef60ab7",
"custom": {
"department_nest": "1|Footwear",
"subdepartmentpath": "1|Summer Sale",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "110.0000",
"rating": "+0000000000000004.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "4.0000",
"rating_stars": null,
"required": null,
"sectioncategory": null,
"size-property": "6.5",
...
},
"customDict": {
"department_nest": "1|Footwear",
"subdepartmentpath": "1|Summer Sale",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "110.0000",
"rating": "+0000000000000004.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "4.0000",
"rating_stars": null,
"required": null,
"sectioncategory": null,
"size-property": "6.5",
...
}
},
{
"brand": "The North Face",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/BOYS-BOUNDARY-TRICLIMATE-JACKET-Cosmic-Blue-Hero.jpg",
"isOnSale": false,
"salePrice": "170.0000",
"bestFragment": null,
"color": "Black",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_72267",
"id": "Item_72267",
"imageAlt": "BOYS-BOUNDARY-TRICLIMATE-JACKET-Cosmic-Blue-Hero",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Boys' Boundary Triclimate Jacket",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000001.5000",
"shortDescription": null,
"sku": null,
"itemIndex": 8,
"modelName": "Also Bought",
"modelType": "AlsoBought",
"modelGuid": "aaba133b-bccb-4e6b-abbf-ae1cfef60ab7",
"custom": {
"department_nest": "1|Kids",
"subdepartmentpath": "1|Specials",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "170.0000",
"rating": "+0000000000000001.5000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "1.5000",
...
},
"customDict": {
"department_nest": "1|Kids",
"subdepartmentpath": "1|Specials",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "170.0000",
"rating": "+0000000000000001.5000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "1.5000",
...
}
}
],
"html": null,
"widgetGuid": "ac843f01-3391-41ee-9db2-36929a021622",
"widgetName": "Our Picks for You",
"widgeTitle": "Our Picks for You",
"widgetCssClass": "",
"isCarousel": true,
"carouselData": {
"showNextPrevButtons": true,
"autoRotate": false,
"autoRotateSpeed": 3000,
"animationSpeed": 750,
"nofVisible": 4,
"isCircular": true,
"scrollNumber": 4,
"showDots": true,
"enableResponsive": true,
"responseiveConfig": "[\n {\n \"breakpoint\": 1024,\n \"settings\": {\n \"slidesToShow\": 4,\n \"slidesToScroll\": 4 \n }\n },\n {\n \"breakpoint\": 860,\n \"settings\": {\n \"slidesToShow\": 4,\n \"slidesToScroll\": 4 \n }\n },\n {\n \"breakpoint\": 600,\n \"settings\": {\n \"slidesToShow\": 3,\n \"slidesToScroll\": 3 \n }\n },\n {\n \"breakpoint\": 768,\n \"settings\": {\n \"slidesToShow\": 3,\n \"slidesToScroll\": 3 \n }\n }, \n {\n \"breakpoint\": 480,\n \"settings\": {\n \"slidesToShow\": 2,\n \"slidesToScroll\": 2\n }\n },\n {\n \"breakpoint\": 240,\n \"settings\": {\n \"slidesToShow\": 1,\n \"slidesToScroll\": 1\n }\n }\n]"
},
"isVertical": false,
"itemsCount": 12
},
{
"recommendationItems": [
{
"brand": "The North Face",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/92222443S07.jpg",
"isOnSale": false,
"salePrice": "55.0000",
"bestFragment": null,
"color": "Black",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_124104",
"id": "Item_124104",
"imageAlt": "124104",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Youth Resolve Pant",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000005.0000",
"shortDescription": null,
"sku": null,
"itemIndex": 2,
"modelName": "Most Popular",
"modelType": "MostPopular",
"modelGuid": "7684b354-0b15-49ee-95ec-e9acff0a6f22",
"custom": {
"department_nest": "1|Kids",
"subdepartmentpath": "1|Specials",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "55.0000",
"rating": "+0000000000000005.0000",
...
},
{
"brand": "Oboz",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/Oboz-Sawtooth-Low-BDRY-Violet.jpg",
"isOnSale": false,
"salePrice": "135.0000",
"bestFragment": null,
"color": "Purple",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_145568",
"id": "Item_145568",
"imageAlt": "Oboz-Sawtooth-Low-BDRY-Violet",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Women's Sawtooth Low BDRY",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000003.0000",
"shortDescription": null,
"sku": null,
"itemIndex": 4,
"modelName": "Add To Cart For Me",
"modelType": "AddToCartForMe",
"modelGuid": "6bc2b868-ec38-489e-8a84-f811059ae603",
"custom": {
"department_nest": "1|Footwear",
"subdepartmentpath": "1|Summer Sale",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "135.0000",
"rating": "+0000000000000003.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "3.0000",
"rating_stars": null,
"required": null,
...
},
"customDict": {
"department_nest": "1|Footwear",
"subdepartmentpath": "1|Summer Sale",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "135.0000",
"rating": "+0000000000000003.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "3.0000",
...
}
}
],
"html": null,
"widgetGuid": "ac843f01-3391-41ee-9db2-36929a021622",
"widgetName": "Our Picks for You",
"widgeTitle": "Our Picks for You",
"widgetCssClass": "",
"isCarousel": true,
"carouselData": {
"showNextPrevButtons": true,
"autoRotate": false,
"autoRotateSpeed": 3000,
"animationSpeed": 750,
"nofVisible": 4,
"isCircular": true,
"scrollNumber": 4,
"showDots": true,
"enableResponsive": true,
"responseiveConfig": "[\n {\n \"breakpoint\": 1024,\n \"settings\": {\n \"slidesToShow\": 4,\n \"slidesToScroll\": 4 \n }\n },\n {\n \"breakpoint\": 860,\n \"settings\": {\n \"slidesToShow\": 4,\n \"slidesToScroll\": 4 \n }\n },\n {\n \"breakpoint\": 600,\n \"settings\": {\n \"slidesToShow\": 3,\n \"slidesToScroll\": 3 \n }\n },\n {\n \"breakpoint\": 768,\n \"settings\": {\n \"slidesToShow\": 3,\n \"slidesToScroll\": 3 \n }\n }, \n {\n \"breakpoint\": 480,\n \"settings\": {\n \"slidesToShow\": 2,\n \"slidesToScroll\": 2\n }\n },\n {\n \"breakpoint\": 240,\n \"settings\": {\n \"slidesToShow\": 1,\n \"slidesToScroll\": 1\n }\n }\n]"
},
"isVertical": false,
"itemsCount": 12
}
],
"isSuccess": true,
"requestId": "6c4a9772-b4c5-4421-80de-fc1692b6e751"
}
Sample Response (Different widget with same uniqueIds)
{
"widgetItems": [
{
"recommendationItems": [
{
"brand": "The North Face",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/TNF-Venture-Jacket-Moonstruck-Grey_Sedona-Sage-Grey.jpg",
"isOnSale": false,
"salePrice": "99.0000",
"bestFragment": null,
"color": "Black",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_72246",
"id": "Item_72246",
"imageAlt": "TNF-Venture-Jacket-Moonstruck-Grey_Sedona-Sage-Grey",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Men's Venture Jacket",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000004.0000",
"shortDescription": null,
"sku": null,
"itemIndex": 1,
"modelName": "Most Popular",
"modelType": "MostPopular",
"modelGuid": "7684b354-0b15-49ee-95ec-e9acff0a6f22",
"custom": {
"department_nest": "1|Men",
"subdepartmentpath": "1|Summer Sale",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "99.0000",
...
},
{
"brand": "Oboz",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/Womens-Sawtooth-Low-clover.jpg",
"isOnSale": false,
"salePrice": "110.0000",
"bestFragment": null,
"color": "Green",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_108946",
"id": "Item_108946",
"imageAlt": "Women's Sawtooth Low",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Women's Sawtooth Low",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000004.0000",
"shortDescription": null,
"sku": null,
"itemIndex": 7,
"modelName": "Also Bought",
"modelType": "AlsoBought",
"modelGuid": "aaba133b-bccb-4e6b-abbf-ae1cfef60ab7",
"custom": {
"department_nest": "1|Footwear",
"subdepartmentpath": "1|Summer Sale",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "110.0000",
"rating": "+0000000000000004.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "4.0000",
"rating_stars": null,
"required": null,
"sectioncategory": null,
"size-property": "6.5",
...
},
"customDict": {
"department_nest": "1|Footwear",
"subdepartmentpath": "1|Summer Sale",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "110.0000",
"rating": "+0000000000000004.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "4.0000",
...
}
},
...
],
"html": null,
"widgetGuid": "ac843f01-3391-41ee-9db2-36929a021622",
"widgetName": "Our Picks for You",
"widgeTitle": "Our Picks for You",
"widgetCssClass": "",
"isCarousel": true,
"carouselData": {
"showNextPrevButtons": true,
"autoRotate": false,
"autoRotateSpeed": 3000,
"animationSpeed": 750,
"nofVisible": 4,
"isCircular": true,
"scrollNumber": 4,
"showDots": true,
"enableResponsive": true,
"responseiveConfig": "[\n {\n \"breakpoint\": 1024,\n \"settings\": {\n \"slidesToShow\": 4,\n \"slidesToScroll\": 4 \n }\n },\n {\n \"breakpoint\": 860,\n \"settings\": {\n \"slidesToShow\": 4,\n \"slidesToScroll\": 4 \n }\n },\n {\n \"breakpoint\": 600,\n \"settings\": {\n \"slidesToShow\": 3,\n \"slidesToScroll\": 3 \n }\n },\n {\n \"breakpoint\": 768,\n \"settings\": {\n \"slidesToShow\": 3,\n \"slidesToScroll\": 3 \n }\n }, \n {\n \"breakpoint\": 480,\n \"settings\": {\n \"slidesToShow\": 2,\n \"slidesToScroll\": 2\n }\n },\n {\n \"breakpoint\": 240,\n \"settings\": {\n \"slidesToShow\": 1,\n \"slidesToScroll\": 1\n }\n }\n]"
},
"isVertical": false,
"itemsCount": 12
},
{
"recommendationItems": [
{
"brand": "Aventura",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/redford-jacket-holiday.jpg",
"isOnSale": true,
"salePrice": "61.9700",
"bestFragment": null,
"color": "White",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_173381",
"id": "Item_173381",
"imageAlt": "redford-jacket-holiday",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Women's Redford Jacket",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000000.5000",
"shortDescription": null,
"sku": null,
"itemIndex": 6,
"modelName": "Also Viewed",
"modelType": "AlsoViewed",
"modelGuid": "3f729ca9-d44e-42a1-8299-f7ce8c564176",
"custom": {
"department_nest": "1|Women",
"subdepartmentpath": "1|Sale",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "89.0000",
"rating": "+0000000000000000.5000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "0.5000",...
},
"customDict": {
"department_nest": "1|Women",
"subdepartmentpath": "1|Sale",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "89.0000",
"rating": "+0000000000000000.5000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "0.5000",...
}
}
],
"html": null,
"widgetGuid": "ecaee03b-3b9b-42b2-a645-7e7709bc120d",
"widgetName": "Shopping Cart Recommendation",
"widgeTitle": "You might also like",
"widgetCssClass": null,
"isCarousel": true,
"carouselData": {
"showNextPrevButtons": true,
"autoRotate": true,
"autoRotateSpeed": 1000,
"animationSpeed": 1000,
"nofVisible": 5,
"isCircular": true,
"scrollNumber": 1,
"showDots": true,
"enableResponsive": true,
"responseiveConfig": "[\r\n {\r\n breakpoint: 1024,\r\n settings: {\r\n slidesToShow: item.carouselData.nofVisible,\r\n slidesToScroll: item.carouselData.scrollNumber,\r\n infinite: true,\r\n arrows: item.carouselData.showNextPrevButtons,\r\n dots: showDots\r\n }\r\n },\r\n {\r\n breakpoint: 860,\r\n settings: {\r\n slidesToShow: Math.min(4, item.carouselData.nofVisible),\r\n slidesToScroll: 4,\r\n infinite: true,\r\n arrows: item.carouselData.showNextPrevButtons,\r\n dots: showDots\r\n }\r\n },\r\n {\r\n breakpoint: 600,\r\n settings: {\r\n slidesToShow: Math.min(3, item.carouselData.nofVisible),\r\n slidesToScroll: 3,\r\n arrows: item.carouselData.showNextPrevButtons\r\n }\r\n },\r\n {\r\n breakpoint: 480,\r\n settings: {\r\n slidesToShow: Math.min(2, item.carouselData.nofVisible),\r\n slidesToScroll: 2,\r\n arrows: item.carouselData.showNextPrevButtons\r\n }\r\n },\r\n {\r\n breakpoint: 240,\r\n settings: {\r\n slidesToShow: 1,\r\n slidesToScroll: 1,\r\n arrows: item.carouselData.showNextPrevButtons\r\n }\r\n }\r\n]"
},
"isVertical": false,
"itemsCount": 6
},
{
"recommendationItems": [
{
"brand": "PacSafe",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/coversafe-v75-10139103-grey-usage.jpg",
"isOnSale": false,
"salePrice": "21.9500",
"bestFragment": null,
"color": "Black",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_174783",
"id": "Item_174783",
"imageAlt": "coversafe-v75-10139103-grey-usage",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Coversafe V75 RFID blocking neck pouch",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000000.0000",
"shortDescription": null,
"sku": null,
"itemIndex": 12,
"modelName": "Featured Items (2)",
"modelType": "FeaturedItems",
"modelGuid": "6e0c6ea4-3d78-4528-93b2-3b653cb564bb",
"custom": {
"department_nest": "1|Travel",
"subdepartmentpath": "1|Travel",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "21.9500",
"rating": "+0000000000000000.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "0.0000",
...
},
"customDict": {
"department_nest": "1|Travel",
"subdepartmentpath": "1|Travel",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "21.9500",
"rating": "+0000000000000000.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "0.0000",
...
}
}
],
"html": null,
"widgetGuid": "bdc3f609-946c-4501-8abe-2bed63055fb6",
"widgetName": "Recommendation - Bottom",
"widgeTitle": "<strong><em><span style=\"text-decoration: underline\">You </span></em></strong>May Also Like...",
"widgetCssClass": "custom-buttons",
"isCarousel": true,
"carouselData": {
"showNextPrevButtons": true,
"autoRotate": false,
"autoRotateSpeed": 1000,
"animationSpeed": 1500,
"nofVisible": 4,
"isCircular": true,
"scrollNumber": 2,
"showDots": false,
"enableResponsive": true,
"responseiveConfig": "[{\n \"breakpoint\": 1024,\n \"settings\": {\n \"infinite\": true\n\n }\n}, {\n \"breakpoint\": 860,\n \"settings\": {\n \"slidesToShow\": 4,\n \"slidesToScroll\": 4,\n \"infinite\": true\n\n }\n}, {\n \"breakpoint\": 600,\n \"settings\": {\n \"slidesToShow\": 3,\n \"slidesToScroll\": 3\n }\n}, {\n \"breakpoint\": 480,\n \"settings\": {\n \"slidesToShow\": 2,\n \"slidesToScroll\": 2\n }\n}, {\n \"breakpoint\": 240,\n \"settings\": {\n \"slidesToShow\": 1,\n \"slidesToScroll\": 1,\n \"arrows\": false\n }\n}]"
},
"isVertical": false,
"itemsCount": 12
}
],
"isSuccess": true,
"requestId": "67ec9d8b-adb4-44fa-ad2b-4ea69c10c9a5"
}
Sample Response (Different widget with different uniqueIds)
{
"widgetItems": [
{
"recommendationItems": [
{
"brand": "The North Face",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/TNF-Venture-Jacket-Moonstruck-Grey_Sedona-Sage-Grey.jpg",
"isOnSale": false,
"salePrice": "99.0000",
"bestFragment": null,
"color": "Black",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_72246",
"id": "Item_72246",
"imageAlt": "TNF-Venture-Jacket-Moonstruck-Grey_Sedona-Sage-Grey",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Men's Venture Jacket",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000004.0000",
"shortDescription": null,
"sku": null,
"itemIndex": 1,
"modelName": "Most Popular",
"modelType": "MostPopular",
"modelGuid": "7684b354-0b15-49ee-95ec-e9acff0a6f22",
"custom": {
"department_nest": "1|Men",
"subdepartmentpath": "1|Summer Sale",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "99.0000",
"rating": "+0000000000000004.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "4.0000",
...
},
"customDict": {
"department_nest": "1|Men",
"subdepartmentpath": "1|Summer Sale",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "99.0000",
"rating": "+0000000000000004.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "4.0000",
...
}
},
{
"brand": "The North Face",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/92222443S07.jpg",
"isOnSale": false,
"salePrice": "55.0000",
"bestFragment": null,
"color": "Black",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_124104",
"id": "Item_124104",
"imageAlt": "124104",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Youth Resolve Pant",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000005.0000",
"shortDescription": null,
"sku": null,
"itemIndex": 2,
"modelName": "Most Popular",
"modelType": "MostPopular",
"modelGuid": "7684b354-0b15-49ee-95ec-e9acff0a6f22",
"custom":
"department_nest": "1|Kids",
"subdepartmentpath": "1|Specials",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "55.0000",
"rating": "+0000000000000005.0000",
...
},
"customDict": {
"department_nest": "1|Kids",
"subdepartmentpath": "1|Specials",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "55.0000",
"rating": "+0000000000000005.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "5.0000",
"rating_stars": null,
...
}
},
{
"brand": "Lowa",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/Lowa-Ferrox-GTX-Lo-Black_Grey.jpg",
"isOnSale": false,
"salePrice": "175.0000",
"bestFragment": null,
"color": "Black",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_161686",
"id": "Item_161686",
"imageAlt": "Lowa-Ferrox-GTX-Lo-Black_Grey",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Men's Ferrox GTX Lo",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000001.5000",
"shortDescription": null,
"sku": null,
"itemIndex": 3,
"modelName": "Add To Cart For Me",
"modelType": "AddToCartForMe",
"modelGuid": "6bc2b868-ec38-489e-8a84-f811059ae603",
"custom": {
"department_nest": "1|Footwear",
"subdepartmentpath": "1|Specials",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "175.0000",
"rating": "+0000000000000001.5000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "1.5000",
"rating_stars": null,
"required": null,
"sectioncategory": null,
"size-property": "8.5",
...
},
"customDict": {
"department_nest": "1|Footwear",
"subdepartmentpath": "1|Specials",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "175.0000",
"rating": "+0000000000000001.5000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "1.5000",
"rating_stars": null,
"required": null,
"sectioncategory": null,
"size-property": "8.5",
...
}
},
...
],
"html": null,
"widgetGuid": "ac843f01-3391-41ee-9db2-36929a021622",
"widgetName": "Our Picks for You",
"widgeTitle": "Our Picks for You",
"widgetCssClass": "",
"isCarousel": true,
"carouselData": {
"showNextPrevButtons": true,
"autoRotate": false,
"autoRotateSpeed": 3000,
"animationSpeed": 750,
"nofVisible": 4,
"isCircular": true,
"scrollNumber": 4,
"showDots": true,
"enableResponsive": true,
"responseiveConfig": "[\n {\n \"breakpoint\": 1024,\n \"settings\": {\n \"slidesToShow\": 4,\n \"slidesToScroll\": 4 \n }\n },\n {\n \"breakpoint\": 860,\n \"settings\": {\n \"slidesToShow\": 4,\n \"slidesToScroll\": 4 \n }\n },\n {\n \"breakpoint\": 600,\n \"settings\": {\n \"slidesToShow\": 3,\n \"slidesToScroll\": 3 \n }\n },\n {\n \"breakpoint\": 768,\n \"settings\": {\n \"slidesToShow\": 3,\n \"slidesToScroll\": 3 \n }\n }, \n {\n \"breakpoint\": 480,\n \"settings\": {\n \"slidesToShow\": 2,\n \"slidesToScroll\": 2\n }\n },\n {\n \"breakpoint\": 240,\n \"settings\": {\n \"slidesToShow\": 1,\n \"slidesToScroll\": 1\n }\n }\n]"
},
"isVertical": false,
"itemsCount": 12
},
{
"recommendationItems": [
{
"brand": "White Sierra",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/Trabagon-Rain-Jacket_Dark-Grey.jpg",
"isOnSale": true,
"salePrice": "39.9700",
"bestFragment": null,
"color": "Black",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_73494",
"id": "Item_73494",
"imageAlt": "Trabagon-Rain-Jacket_Dark-Grey",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Men's Trabagon Rain Jacket",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000003.0000",
"shortDescription": null,
"sku": null,
"itemIndex": 1,
"modelName": "Featured Items",
"modelType": "FeaturedItems",
"modelGuid": "630e8927-dd76-4755-a99e-2517d05ac0d5",
"custom": {
"department_nest": "1|Men",
"subdepartmentpath": "1|Sale",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "60.0000",
"rating": "+0000000000000003.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "3.0000",
...
},
"customDict": {
"department_nest": "1|Men",
"subdepartmentpath": "1|Sale",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "60.0000",
"rating": "+0000000000000003.0000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "3.0000",
...
}
},
{
"brand": "The North Face",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/North-Face-womens-Denali-Jacket-Black.jpg",
"isOnSale": false,
"salePrice": "179.0000",
"bestFragment": null,
"color": "Black",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_119712",
"id": "Item_119712",
"imageAlt": "North-Face-womens-Denali-Jacket-Black",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Women's Denali Jacket",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000005.0000",
"shortDescription": null,
"sku": null,
"itemIndex": 2,
"modelName": "Featured Items",
"modelType": "FeaturedItems",
"modelGuid": "630e8927-dd76-4755-a99e-2517d05ac0d5",
"custom": {
"department_nest": "1|Summer Sale",
"subdepartmentpath": "1|Women",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "179.0000",
"rating": "+0000000000000005.0000",
...
},
{
"brand": "La Sportiva",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/La-Sportiva-Ultra-Raptor-Black_Yellow.jpg",
"isOnSale": false,
"salePrice": "130.0000",
"bestFragment": null,
"color": "Black",
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_164653",
"id": "Item_164653",
"imageAlt": "La-Sportiva-Ultra-Raptor-Black_Yellow",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Men's Ultra Raptor",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000003.5000",
"shortDescription": null,
"sku": null,
"itemIndex": 2,
"modelName": "Personalized",
"modelType": "Personalized",
"modelGuid": "6ea471e5-2ea9-43da-846b-fe514a270513",
"custom": {
"department_nest": "1|Footwear",
"subdepartmentpath": "1|Run & Fitness",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "130.0000",
"rating": "+0000000000000003.5000",
...
},
"customDict": {
"department_nest": "1|Footwear",
"subdepartmentpath": "1|Run & Fitness",
"itemtypeid": "3.0000",
"listingasseturl": null,
"new_field_name": null,
"no_of_balls_per_plate": null,
"price": "130.0000",
"rating": "+0000000000000003.5000",
"ratingCopy": null,
"ratingCopy2": null,
"ratingrange": "3.5000",
"rating_stars": null,
"required": null,
"sectioncategory": null,
"size-property": "43.5",...
}
},
{
"brand": "Coghlans",
"price": null,
"imageUrl": "https://dev.hawksearch.net/assets/1/14/DimThumbnail/0242.jpg",
"isOnSale": false,
"salePrice": "2.5000",
"bestFragment": null,
"color": null,
"url": "http://demo-dev.hawksearch.net/details.aspx?itemid=Item_124103",
"id": "Item_124103",
"imageAlt": "0242 kids poncho",
"imageOverAltTag": null,
"imageOverUrl": null,
"itemName": "Poncho For Kids",
"maxPrice": null,
"maxSalePrice": null,
"minPrice": null,
"minSalePrice": null,
"postDate": null,
"rating": "+0000000000000000.0000",
"shortDescription": null,
"sku": "9221676B400000",
"itemIndex": 3,
"modelName": "Also Viewed",
"modelType": "AlsoViewed",
],
"isSuccess": true,
"requestId": "513623cf-c931-4fd2-b079-21884bdb62c8"
}
, multiple selections available,
Related content
Events Tracking API Integration
Events Tracking API Integration
Read with this
Recommendations
Recommendations
More like this
Conversion Tracking Summary
Conversion Tracking Summary
Read with this
API - front end integration
API - front end integration
More like this
Custom Visitor Targets
Custom Visitor Targets
Read with this
JavaScript Integration
JavaScript Integration
More like this