v1

latestOpenAPI 3.0.42026-07-2685196386.6 KB
Review

Get reviews

Gets the current and previous reviews for a store. Requires the stores.view permission.

get/stores/{storeId}/reviews

Path parameters

storeIdstring uuid required

The ID of the store to get the reviews for

Query parameters

ratinginteger

Filter by star rating (exact match).

emailAddressstring

Case-insensitive contains on the customer’s email address.

hasReplyboolean

Only reviews that have a merchant reply.

dateRangeFromstring date-time

Reviews created on or after this date.

dateRangeTostring date-time

Reviews created on or before this date.

Filtersstring
Sortsstring
Pageinteger
PageSizeinteger

Response

The object was successfully returned.

successboolean required

Indicates whether the operation was successful

pagesinteger required

The total number of pages available in the paginated response.