reviews

Fetch a single review.

This endpoiont allows you to fetch a single review either by review_id (found from the /reviews/{siteid} path) or from an order ID that was passed from your system to ours. If you have not sent us order ID information, looking up by order ID will not work.

get/reviews/{siteid}/{reviewid}

Request

Base URL
https://api.shopperapproved.com
Auth
none declared
TypeScript
https://skmtc.dev/shopperapproved/apis/shopper-approved-api/docs/reviews/:siteid/:reviewid/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

siteidinteger required

The Site ID you are requesting the review for.

reviewidstring required

The review_id or order ID of the review you are requesting.

Query parameters

tokenstring required

Your API token.

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.

full_name0 | 1

Include customer full name or abbreviate last name.

xmlboolean

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

Response

Success - a JSON entry for your review will be returned.

Changes

No recorded changes to this operation across all 1 revision of this API.