reviews

Create a new review entry.

This API endpoint is used to ingest a Order, Email, and Follow-up Date so that the Shopper Approved system will send a survey request using that data. You cannot submit reviews to this endpoint. Abuse of this endpoint could result in removal of the ability to use the Shopper Approved API. Only send a single review per call.

post/reviews/{siteid}

Request

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

Path parameters

siteidinteger required

The SiteID for which you are creating an entry.

Query parameters

xmlboolean

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

Request body application/x-www-form-urlencoded

tokenstring required

Your API token.

namestring

The customer's name. If not provided, will be saved as "Anonymous Customer"

orderidstring required

The unique Order ID. If not unique and not test, a 419 erorr will be returned.

productsstring

A comma separated list of product ids (no spaces after the commas) to be attached to the review.

emailstring required

The customer's email. Must be provided so that the follow up email may be sent.

followupstring required

The date in YYYY-MM-DD format that the customer should receive the follow-up email.

testboolean

Whether or not this review entry should be considered a test. Allows for duplicate order IDs, review will never be public.

custom_questionsstring

A JSON encoded object of custom question headers and their responses.

Response

The review was successfully created.

Changes

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