v1

latestOpenAPI 3.0.12026-07-139031.1 KB
products

Fetches product reviews.

This route will pull in all product reviews matching the provided parameters. By default it will pull 100 reviews at a time.

get/products/reviews/{siteid}

Path parameters

siteidinteger required

The site ID you are requesting product reviews for.

Query parameters

tokenstring required

Your API token

asArrayboolean

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

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 with your product reviews will be returned.