almost 10 years ago
The SHOP.COM API Product Review Snapshot
The SHOP.COM API Product Review Snapshot
The response for a product detail call includes two attributes related to reviews: the total number of reviews and the overall rating (using a 5-star rating scale).
With this review snapshot conveniently provided in the API response, an application has many options in creating an innovative user experience such as sorting and filtering by review counts and/or the overall rating.
Example
This call:
https://api.shop.com/AffiliatePublisherNetwork/v1/products/600496809?publisherID=TEST&locale=en_US
Returns this response ("review snapshot" data is in bold):
{
"name": "Snap™ Disinfectant Cleaner",
"maximumPrice": "$12.95",
"minimumPrice": "$12.95",
"id": 600496809,
"brand": "SNAP™",
"shortDescription": "Clean, deodorize and disinfect a variety of surfaces with Snap Disinfectant Cleaner. This phosphate-free cleaner is designed for use in food service establishments, hotels and motels, nursing homes, hospitals and more. It is an EPA-registered product...",
"description": "<p style=\"background: url('http://images.marketamerica.com/images/usa/unfranchise/icon-pdf.png') no-repeat 0 0; padding: 8px 0 8px 30px;\"><a href=\"http://images.shop.com/pdf/USA/ENG/2302/snap-disinfectant-cleaner.pdf\" target=\"_blank\">Product Brochure</a></p><p>Clean, deodorize and disinfect a variety of surfaces with Snap Disinfectant Cleaner. This phosphate-free cleaner is designed for use in food service establishments, hotels and motels, nursing homes, hospitals and more. It is an EPA-registered product and helpful in preventing cross-contamination in both commercial facilities and homes. Since this disinfectant cleaner is a concentrated solution, one bottle replaces up to 32 bottles of typical anti-bacterial cleaners, saving you money. Snap Disinfectant Cleaner is also a fungicide, virucide and mildew fighter.</p><p>Use Snap Disinfectant Cleaner in your bathroom, kitchen, athletic center or anywhere else where germs often accumulate. The formula is biodegradable and phosphate-free. Before using this natural disinfectant cleaner, dilute it to the proper concentration. To clean hard, non-porous surfaces, mix 2 ounces of Snap with 1 gallon of water. This disinfectant also removes mildew and is effective against many organisms, including E. coli, Strep. faecalis and Staph aureus. When you clean with Snap, you deodorize and disinfect at the same time.</p><p>",
"cashBack": 0.26,
"distributorCashBack": 0.26,
"ciPoints": 0,
"bv": 5,
"ibv": 0,
"freeShipping": true,
"catalogName": "Market America",
"catalogDescription": "<p style=\"background: url('http://images.marketamerica.com/images/usa/unfranchise/icon-pdf.png') no-repeat 0 0; padding: 8px 0 8px 30px;\"><a href=\"http://images.shop.com/pdf/USA/ENG/2302/snap-disinfectant-cleaner.pdf\" target=\"_blank\">Product Brochure</a></p><p>Clean, deodorize and disinfect a variety of surfaces with Snap Disinfectant Cleaner. This phosphate-free cleaner is designed for use in food service establishments, hotels and motels, nursing homes, hospitals and more. It is an EPA-registered product and helpful in preventing cross-contamination in both commercial facilities and homes. Since this disinfectant cleaner is a concentrated solution, one bottle replaces up to 32 bottles of typical anti-bacterial cleaners, saving you money. Snap Disinfectant Cleaner is also a fungicide, virucide and mildew fighter.</p><p>Use Snap Disinfectant Cleaner in your bathroom, kitchen, athletic center or anywhere else where germs often accumulate. The formula is biodegradable and phosphate-free. Before using this natural disinfectant cleaner, dilute it to the proper concentration. To clean hard, non-porous surfaces, mix 2 ounces of Snap with 1 gallon of water. This disinfectant also removes mildew and is effective against many organisms, including E. coli, Strep. faecalis and Staph aureus. When you clean with Snap, you deodorize and disinfect at the same time.</p><p>",
"catalogLogoImageFileName": "http://edge.shop.com/ccimg.shop.com/topbrands/nmlogos_72094.gif",
"imageURL": "http://edge.shop.com/ccimg.shop.com/240000/243300/243390/products/559053527.jpg",
"referralUrl": "http://www.shop.com/559053527-p.xhtml?publisherID=TEST",
"autoShip": true,
"onSale": false,
"disclaimer": "*These statements have not been evaluated by the Food and Drug Administration. This product(s) is not intended to diagnose, treat, cure or prevent any disease.",
"category": {
"id": 4013197,
"name": "Home Store"
},
"reviewData": {
"count": "22",
"rating": 5
},
"links": [
{
"rel": "referralPage",
"href": "http://www.shop.com/559053527-p.xhtml?publisherID=TEST",
"type": "text/html"
}
]
}