Submit a review for an invitation
const url = 'https://apibase.ecomweb.app/api/v1/public/stores/example/review-invitations/example/submit';const options = { method: 'POST', headers: { 'x-storefront-api-key': '<x-storefront-api-key>', 'Content-Type': 'application/json' }, body: '{"rating":1,"content":"example","title":"example","pros":["example"],"cons":["example"],"media":[{}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://apibase.ecomweb.app/api/v1/public/stores/example/review-invitations/example/submit \ --header 'Content-Type: application/json' \ --header 'x-storefront-api-key: <x-storefront-api-key>' \ --data '{ "rating": 1, "content": "example", "title": "example", "pros": [ "example" ], "cons": [ "example" ], "media": [ {} ] }'Creates a verified-buyer review for the product the invitation is for and marks the invitation as submitted. The review waits for the merchant’s approval before it is shown. An invitation that is unknown, expired or already used answers 400. The response currently includes merchant-side fields of the review, such as reviewer_email and the moderation fields.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The invitation token, sent to the customer by email.
The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Star rating, from 1 to 5.
Review text, at least 10 characters.
Review title.
What the reviewer liked.
What the reviewer disliked.
Photos or other media: a list of objects such as { "url": "https://...", "type": "image" }.
object
Example generated
{ "rating": 1, "content": "example", "title": "example", "pros": [ "example" ], "cons": [ "example" ], "media": [ {} ]}Responses
Section titled “Responses”object
ID of the reviewed variant, or null.
Name of the reviewed variant, or null.
ID of the order the review is about, or null.
Number of the order the review is about, or null.
ID of the customer account that wrote the review, or null.
URL of the reviewer’s avatar, or null.
Review title, or null.
Photos or other media attached to the review: a list of objects such as { "url": "https://...", "type": "image" }.
object
Moderation status: PENDING, APPROVED, REJECTED or HIDDEN. Only APPROVED reviews are shown to shoppers.
Internal moderation notes, or null.
ID of the user who approved the review, or null.
When the review was approved, as an ISO 8601 timestamp, or null.
Why the review was rejected, or null.
Position used when sorting by display_order, or null.
The review’s ID on the platform it was imported from, or null.
The date shown for the review, as an ISO 8601 timestamp, or null. Imported reviews keep their original date here.
When the review was deleted. Always null on reviews you can read.
The review’s replies. Present only when replies are requested with include_replies on the list route.
object
When the reply was deleted. Always null on replies you can read.
Reply ID.
ID of the review the reply answers.
Reply text.
ID of the user who wrote the reply.
Name shown as the reply’s author.
Whether the reply is shown to shoppers.
When the reply was created, as an ISO 8601 timestamp.
When the reply was last updated, as an ISO 8601 timestamp.
Review ID.
ID of the reviewed product.
Name of the reviewed product when the review was written.
Reviewer’s name.
Reviewer’s email.
Whether the reviewer bought the product from the store.
Star rating, 1 to 5.
Review text.
What the reviewer liked.
What the reviewer disliked.
Whether the review is featured.
Whether the review is pinned to the top of the list.
When the review was created, as an ISO 8601 timestamp.
When the review was last updated, as an ISO 8601 timestamp.
Example
{ "status": "PENDING"}The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}