Sample request and response to integrate a recommendation widget
The following sections contain a sample request and response for the scenario described in Create a request to get recommendation widget data.
Request
The following code shows a sample request to integrate a recommendation widget:
RequestResponse
{
"context": {
"page": {
"uri": "/magnum-shielding/1-in-chrome-ape-hanger-10-in-rise-handlebars-3hb-0510.p5904622.prd/5904622.sku",
"locale_country": "us",
"locale_language": "en",
"product_group": [
"product_p5904622"
],
"sku": [
"5493"
]
},
"user": {
"uuid": "SampleUUID"
}
},
"batch": [
{
"widget": {
"rfkid": "rfkid_31"
}
},
{
"widget": {
"rfkid": "rfkid_32"
}
}
],
"n_item": 1,
"page_number": 1,
"content": {
"product": {}
}
}Response
Within the content response object, there is a nested product and then value object. You can get the information you need to populate one product slot from the keys and values in the value object.
The following code shows a sample response for the above request:
RequestResponse
{
"url": "?data%3D%7B%22force_v2_specs%22%3A%20true%2C%20%22batch%22%3A%20%5B%7B%22widget%22%3A%20%7B%22rfkid%22%3A%20%22rfkid_31%22%2C%20%22used_in%22%3A%20%22page%22%2C%20%22variation_id%22%3A%20%22568982%22%2C%20%22type%22%3A%20%22recommendation%22%7D%7D%2C%20%7B%22widget%22%3A%20%7B%22rfkid%22%3A%20%22rfkid_32%22%2C%20%22used_in%22%3A%20%22page%22%2C%20%22variation_id%22%3A%20%22568985%22%2C%20%22type%22%3A%20%22recommendation%22%7D%7D%5D%2C%20%22content%22%3A%20%7B%22product%22%3A%20%7B%22max%22%3A%201%7D%7D%2C%20%22page_number%22%3A%201%2C%20%22context%22%3A%20%7B%22page%22%3A%20%7B%22sku%22%3A%20%5B%225493%22%5D%2C%20%22product_group%22%3A%20%5B%22product_p5904622%22%5D%2C%20%22locale_country%22%3A%20%22us%22%2C%20%22locale_language%22%3A%20%22en%22%2C%20%22uri%22%3A%20%22/magnum-shielding/1-in-chrome-ape-hanger-10-in-rise-handlebars-3hb-0510.p5904622.prd/5904622.sku%22%7D%2C%20%22user%22%3A%20%7B%22uuid%22%3A%20%22SampleUUID%22%7D%7D%2C%20%22n_item%22%3A%201%7D",
"rid": "response_id:125757327:57612a0c8b2b8b0f3769723cb843c4169f26820d",
"dt": 199,
"batch": [
{
"widget": {
"rfkid": "rfkid_31",
"used_in": "page",
"variation_id": "568982",
"type": "recommendation"
},
"total_item": 1,
"content": {
"product": {
"total_item": 1,
"value": [
{
"special_offer": [],
"attribute_tags": {
"id265": {
"label": "Diameter - Handlebar",
"name_order": 0,
"value_id": "ID24101",
"value": "1 in.",
"order": 5
}
}
"id356": {
"label": "Type - Engine",
"name_order": 987,
"value_id": [
"ID37727",
"ID37728",
"ID37730",
"ID37734",
"ID37737"
],
"value": [
"Evo Sportster Style",
"Ironhead Sportster Style",
"Twin Cam Style",
"Shovelhead Style",
"Evolution Style"
],
"order": [
1,
9,
25,
21,
2
]
}
"id193": {
"label": "Pullback/Sweep - Handlebars",
"name_order": 101,
"value_id": "ID44360",
"value": "6 9/16 in.",
"order": 52
}
},
"category_names": [
"Handlebars - Conventional"
],
"is_new": false,
"product_url": "/magnum-shielding/1-in-chrome-ape-hanger-12-in-rise-handlebars-3hb-0512.p5904623.prd",
"brand_id": "463",
"colors": [],
"max_sku_price": "106.16",
"save_off": "0",
"powersport_id": [
"cat110007"
],
"id": 1770170408,
"sku": "5904623",
"skuid": 993996004,
"breadcrumbs": "Handlebars & Controls>Handlebars>Handlebars - Conventional",
"on_sale": 0,
"final_price": "106.16",
"min_sku_price": "106.16",
"product_group": "product_p5904623",
"price": "106.16",
"manufacturer_part_number": "3HB-0512",
"powersport_group_id": [
"pg1"
],
"powersport_group": [
"Motorcycle"
],
"brand": "Magnum",
"sku_name": "1 in. Chrome Ape Hanger 12 in. Rise Handlebars - 3HB-0512",
"sales_rank": 11705,
"sku_url": "/magnum-shielding/1-in-chrome-ape-hanger-12-in-rise-handlebars-3hb-0512.p5904623.prd/5904623.sku",
"all_category_names": [
"Handlebars & Controls",
"Handlebars",
"Handlebars - Conventional"
],
"powersport": [
"Harley-Davidson"
],
"brands": [
"Magnum"
],
"is_motorcycle_tire": false,
"name": "1 in. Chrome Ape Hanger 12 in. Rise Handlebars - 3HB-0512",
"sizes": [],
"url": "/magnum-shielding/1-in-chrome-ape-hanger-12-in-rise-handlebars-3hb-0512.p5904623.prd",
"variations": "1",
"image_url": "//www.denniskirk.com/dk/product_images/oe/290pix/oep5904623_26fd6fa29f48ca19814e3d9a7e23e501184215fe.jpg",
"ccids": "v8",
"is_product_family": false,
"is_outlet": false,
"has_fitment": true
}
],
"n_item": 1
}
},
"page_number": 1,
"total_page": 1,
"n_item": 1
},
{
"widget": {
"rfkid": "rfkid_32",
"used_in": "page",
"variation_id": "568985",
"type": "recommendation"
},
"total_item": 1,
"content": {
"product": {
"total_item": 1,
"value": [
{
"special_offer": [],
"attribute_tags": {
"id241": {
"label": "Units",
"name_order": 136,
"value_id": "ID1796",
"value": "Set",
"order": 103
},
"id356": {
"label": "Type - Engine",
"name_order": 987,
"value_id": "ID37730",
"value": "Twin Cam Style",
"order": 25
}
},
"category_names": [
"Suspension Accessories & Covers"
],
"is_new": false,
"product_url": "/kuryakyn/swingarm-cover-set-8108.491958.prd",
"brand_id": "428",
"colors": [],
"max_sku_price": "146.69",
"image_additional": "<https://www.denniskirk.com/dk/product_images/oe/290pix/oe491958_51d1716e5410d2c300a34686950fe57ace34b9b1.jpg",
"powersport_id": [
"cat110007"
],
"id": 1825256111,
"sku": "491958",
"skuid": 468912351,
"save_off": "0",
"breadcrumbs": "Suspension>Suspension & Swingarms>Suspension Accessories & Covers",
"on_sale": 0,
"availability": [
"In Stock Only"
],
"sku_image_additional": "<https://www.denniskirk.com/dk/product_images/oe/290pix/oe491958_51d1716e5410d2c300a34686950fe57ace34b9b1.jpg",
"final_price": "146.69",
"min_sku_price": "146.69",
"product_group": "product_491958",
"price": "146.69",
"manufacturer_part_number": "8108",
"cross_reference_number_list": [
"13030032"
],
"powersport_group": [
"Motorcycle"
],
"brand": "Kuryakyn",
"sku_name": "Swingarm Cover Set - 8108",
"sales_rank": 18770,
"sku_url": "/kuryakyn/swingarm-cover-set-8108.491958.prd/491958.sku",
"all_category_names": [
"Suspension Accessories & Covers",
"Suspension",
"Suspension & Swingarms"
],
"powersport": [
"Harley-Davidson"
],
"brands": [
"Kuryakyn"
],
"is_motorcycle_tire": false,
"powersport_group_id": [
"pg1"
],
"name": "Swingarm Cover Set - 8108",
"sizes": [],
"url": "/kuryakyn/swingarm-cover-set-8108.491958.prd",
"universal_product_code_list": [
"191209006266"
],
"variations": "1",
"image_url": "//www.denniskirk.com/dk/product_images/e4/290pix/e491958.jpg",
"ccids": "03811_8405",
"is_product_family": false,
"is_outlet": false,
"has_fitment": true
}
],
"n_item": 1
}
},
"page_number": 1,
"total_page": 1,
"n_item": 1
}
],
"ts": 1652904352764
}
}