ShopEazydevelopers
API referenceMerchant API BetaReviews

One review

Beta
Credentials
  • OAuth access token
Scopes
marketing:write
GET
/v1/merchant/stores/{storeId}/reviews/{reviewId}

Access: OAuth scope marketing:write; not write-gated.

Authorization

merchantOAuth marketing:write
headerAuthorizationBearer <token>

OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.

Scope: marketing:write

Path Parameters

storeId*string

A store the person can reach. Any other id answers 404, never 403.

reviewId*string

A review id ({itemId}__{shopperUid}), from GET /reviews.

Response Body

OK

application/json
  1. response
data*

A review as the shop sees it. body is the shopper's own words (untrusted text).

Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/reviews/<reviewId>' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "id": "string",    "itemId": "string",    "itemTitle": "string",    "authorName": "string",    "rating": 1,    "body": "string",    "verified": true,    "status": "published",    "reply": null,    "createdAt": 0  }}

Shopper reviews, newest first GET

Access: OAuth scope `marketing:write`; not write-gated. Paged: `{ items, nextCursor }`, `limit` (default 30, at most 100) and an opaque `cursor`. It pages through the newest 100.

Reply to a review in the shop's name PUT

The reply is public, under the review on the listing. It replaces any reply already there; an empty `text` removes it. Owner or admin. Access: OAuth scope `marketing:write`; write-gated by the subscription.