Skip to content

List an order's review invitations

GET
/public/stores/{storeRef}/review-invitations/by-order
curl --request GET \
--url 'https://apibase.ecomweb.app/api/v1/public/stores/example/review-invitations/by-order?order_number=1&email=example' \
--header 'x-storefront-api-key: <x-storefront-api-key>'

Returns the review invitations of one order, one per product to review. The order is identified by its number together with the email of the customer who placed it; an order that does not match returns an empty list, as do missing parameters.

storeRef
required
string

The store’s ref, as returned by GET /stores.

order_number
required
integer

The order number.

email
required
string

The email of the customer who placed the order.

Media typeapplication/json
Array<object>
object
variant_name
required

Name of the variant to review, or null.

string
nullable
token
required

The invitation token; use it to read or submit the invitation.

string
product_id
required

ID of the product to review, as a string.

string
product_name
required

Name of the product to review.

string
status
required

Invitation status, such as SENT, OPENED, SUBMITTED or EXPIRED.

string

Example generated

[
{
"variant_name": "example",
"token": "example",
"product_id": "example",
"product_name": "example",
"status": "example"
}
]

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

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.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}