appkeystringRequired
The store ID
domainstringOptional
The account domain
skustringRequired
The ID of the product on your site. This parameter supports alphanumeric (a...z, A...Z, 0...9), "_" and "-" characters.
product_titlestringRequired
The title of the product
product_descriptionstringOptional
The description of the product
product_urlstringOptional
The url of the product on your ecommerce site
product_image_urlstringOptional
The url of the product image
display_namestringRequired
The name of the reviewer
emailstringRequired
The email of the reviewer
is_incentivizedbooleanOptional
Indicates if the review comes from an incentivized source (for example, a product sampling company)
review_contentstringRequired
The content of the review
review_titlestringRequired
The title of the review
review_scorestringRequired
The review score
signaturestringOptional
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_stampstringOptional
Required for customers using the Trusted Vendors feature. Unix timestamp.
submission_time_stampstringOptional
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_typestringOptional
Required for customers using the Trusted Vendors feature. Possible values: verified_buyer or verified_reviewer
delivery_typestringOptional
The type of delivery designated for this purchase e.g. express, expedited, standard
user_referencestringOptional
External user id, can be used later on to retrieve reviews associated with this user
image_urlsarrayOptional
The URLs of images associated with the review. You can upload up to 5 images per review.
coupon_usedbooleanOptional
Part of order_metadata, indicates whether a coupon was used at purchase
namestringOptional
The name of an order-related custom property e.g. order history
valuestringOptional
The order-related custom_properties value
colorstringOptional
The color of the item
sizestringOptional
The size of the item
materialstringOptional
The material the product is made of
modelstringOptional
The model name of the product
vendorstringOptional
The product vendor
statestringOptional
The state the customer is located in
countrystringOptional
Two-letter uppercase country code indicating the customer country. To comply with Google Seller Ratings conventions, the country code value must be from this list of compatible codes. Default value: US.
addressstringOptional
The customer's address
phone_numberstringOptional
The customer's phone number
ratelimit-limitintegerOptional
The maximum number of requests allowed in the current time window
ratelimit-remainingintegerOptional
The number of requests remaining in the current time window
ratelimit-resetintegerOptional
The time (in seconds) until the rate limit resets
x-ratelimit-limit-minuteintegerOptional
The maximum number of requests allowed per minute
x-ratelimit-remaining-minuteintegerOptional
The number of requests remaining in the current minute
order_metadataobjectOptional
order_metadata object
product_metadataobjectOptional
product_metadata object
custom_propertiesobjectOptional
custom_properties object
customer_metadataobjectOptional
customer_metadata object
