Create review (synchronous)

post

https://api.yotpo.com/reviews/dynamic_create

Note: This method is recommended for development only.

Body Params

appkey

string

required

The store ID

domain

string

The account domain

sku

string

required

The ID of the product on your site. 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

The url of the product on your ecommerce site

product_image_url

string

The url of the product image

display_name

string

required

The name of the reviewer

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)

review_content

string

required

The content of the review

review_title

string

required

The title of the review

review_score

string

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.

time_stamp

string

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

submission_time_stamp

string

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

user_reference

string

External user id, can be used later on to retrieve reviews associated with this user

image_urls

array of strings

The URLs of images associated with the review. You can upload up to 5 images per review.

image_urls

order_metadata

object

product_metadata

object

customer_metadata

object

Responses

200200

400400