List review invitations for several orders
const url = 'https://apibase.ecomweb.app/api/v1/public/stores/example/review-invitations/by-orders?order_numbers=1001%2C1002&email=example';const options = {method: 'GET', headers: {'x-storefront-api-key': '<x-storefront-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://apibase.ecomweb.app/api/v1/public/stores/example/review-invitations/by-orders?order_numbers=1001%2C1002&email=example' \ --header 'x-storefront-api-key: <x-storefront-api-key>'Returns the review invitations of several orders at once, as an object keyed by order number. Orders are identified by their numbers together with the email of the customer who placed them; orders that do not match are left out, and missing parameters return an empty object.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Query Parameters
Section titled “Query Parameters”Example
1001,1002Comma-separated order numbers.
The email of the customer who placed the orders.
Responses
Section titled “Responses”object
object
Name of the variant to review, or null.
The invitation token; use it to read or submit the invitation.
ID of the product to review, as a string.
Name of the product to review.
Invitation status, such as SENT, OPENED, SUBMITTED or EXPIRED.
Example generated
{ "additionalProperty": [ { "variant_name": "example", "token": "example", "product_id": "example", "product_name": "example", "status": "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"}