Reply to a review
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/reviews/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/replies';const options = { method: 'POST', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"content":"example","author_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","author_name":"example","is_visible":true}'};
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/stores/example/reviews/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/replies \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "content": "example", "author_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "author_name": "example", "is_visible": true }'Adds the store’s reply to a review. The reply is visible to shoppers unless is_visible is false. The body is not validated beyond what the database requires, so send all of content, author_id and author_name.
Required scopes: write:reviews
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The review ID.
The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Reply text.
ID of the user the reply is attributed to.
Name shown as the reply’s author, up to 100 characters.
Whether the reply is shown to shoppers. Defaults to true.
Responses
Section titled “Responses”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.
Example generated
{ "deleted_at": "example", "id": "example", "review_id": "example", "content": "example", "author_id": "example", "author_name": "example", "is_visible": true, "created_at": "example", "updated_at": "example"}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"}The resource does not exist in this store.
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"}