v1

latestOpenAPI 3.0.12026-07-139031.1 KB

products

Fetch reviews for a given product or parent ID.

This endpoint will fetch all reviews for a given product or parent ID. Using a parent ID will return reviews for all products with that parent ID. By default it will pull 100 reviews at a time. By defaul removed reviews will not be included in the result.

get/products/reviews/{siteid}/{productid}

Path parameters

siteidinteger required

The Site ID you are requesting the review for.

productidstring required

The product ID or parent ID you would like reviews for.

Query parameters

asArrayboolean

If true, this will return the response as a JSON arry as opposed to the standard JSON object. (Enclosed in [] as opposed to {}.)

tokenstring required

Your API token.

limitinteger

How many reviews you want returned in the response. Larger numbers may cause a timeout.

pageinteger

Which page you would like to request. The offset will be calculated by limit * page

fromstring

The date you would like to start the query with. Should be given in YYYY-MM-DD format. Defaults to 30 days prior to the current day.

tostring

The date you would like to end the query with. Should be given in YYYY-MM-DD format. Defaults to the current date.

sort'newest' | 'oldest' | 'highest' | 'lowest'

How you would like to sort the reviews.

removed0 | 1

Include removed reviews? If set to 1 then reviews will include a 'removed' value equal to 1 if the review was removed and 0 if the review is active.

xmlboolean

If true, this will return an XML tree instead of a JSON response.

Response

Success - a JSON object for your reviews will be returned.