Create review

post

https://api.yotpo.com/v1/widget/reviews

This is the asynchronous method and is recommended for general use.

Body Params

appkey

string

required

The store ID

domain

string

The account domain

sku

string

required

The unique ID of the product on your site (doesn't have to be the SKU). To create a site review, use the value: yotpo_site_reviews. This parameter supports alphanumeric (a...z, A...Z, 0...9), "_" and "-" characters.

product_title

string

required

The title of the product

product_description

string

The description of the product

product_url

string

required

The url of the product where the reviews are displayed

product_image_url

string

The url of the product image

display_name

string

required

The reviewer's name

string

required

The email of the reviewer

is_incentivized

boolean

Indicates if the review comes from an incentivized source (for example, a product sampling company)

incentive_type

string

enum

The type of incentive provided for the review

Allowed:

review_content

string

required

The content of the review

review_title

string

required

The title of the review

review_score

int32

required

The review score

signature

string

Relevant only for customers using the Trusted Vendors feature. The signature is the hexadecimal representation of a computed Hash-based Message Authentication Code, using SHA256 as the cryptographic function (HMAC-SHA256). The secret for the function is the account secret. Note: The time_stamp and reviewer_type parameters are mandatory when using the signature parameter.

time_stamp

date-time

Required for customers using the Trusted Vendors feature. Unix timestamp.

submission_time_stamp

date-time

Relevant only for customers using the Trusted Vendors feature. The date the review was created (if not today). Can be up to 7 days in the past. If you want to add a creation date that is more than 7 days in the past, please contact support

reviewer_type

string

Required for customers using the Trusted Vendors feature. Possible values: verified_buyer or verified_reviewer

delivery_type

string

The type of delivery designated for this purchase e.g. express, expedited, standard

order_metadata

object

product_metadata

object

customer_metadata

object

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200200

400400

500500