Skip to navigation
StorefrontReviews

Create Review

View as Markdown

Submits a review from the signed-in shopper. Only shoppers who have ordered the product can review it, and each shopper has one review per product: sending another replaces it. Reviews wait for the merchant’s approval before they are listed.

Keys: public key or secret key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring
The identity for the active workspace.

Path parameters

handlestringRequired
The record's handle.

Headers

channelstringRequired
shopper-tokenstringRequired

The token returned when the shopper signed in. Treat it as a secret: never put it in a URL or a log.

client-ipstringOptional
The shopper's IP address. Read only when the request is signed with a secret key, so a server calling on behalf of many shoppers does not share one rate limit. Ignored for public keys.

Request

This endpoint expects an object.
ratingintegerRequired1-5
Stars, 1 to 5.
bodystringRequired<=5000 characters
Plain text. Markup is removed.
titlestringOptional<=150 characters

Response

Successfully submitted review
statusboolean

Always true on success.

messagestring

Human-readable outcome.

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error