ShopEazydevelopers
API referenceMerchant API BetaReviews

Show or hide a review

Beta
Credentials
  • OAuth access token
Scopes
marketing:write
Subscription
Needs an active plan. Otherwise 403 subscription_locked.
Idempotency
Send an Idempotency-Key header. A retry with the same key does the work once.
PUT
/v1/merchant/stores/{storeId}/reviews/{reviewId}/status

A hidden review leaves the shop and the listing's rating; nothing is deleted. Owner or admin.

Access: OAuth scope marketing:write; write-gated by the subscription.

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.

Header Parameters

Idempotency-Key*string

Required on every write. Minted on the device when the person taps, reused on every retry. A write without one, or with one that does not match the pattern, is refused with 422 validation_error. Scoped to the token's subject, remembered 24 hours. A replay returns the first 2xx response with Idempotent-Replay: true; a request still running answers 409 in_flight; the same key with a different method, path or body answers 409 idempotency_key_reused; non-2xx results are not remembered. If the key store cannot be read nothing is processed and the answer is 503 idempotency_unavailable: retry with the same key.

Match^[A-Za-z0-9_-]{8,128}$

Request Body

application/json
  1. body
status*ReviewStatus
Value in"published""hidden"

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 PUT 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/reviews/<reviewId>/status' \  -H 'Authorization: Bearer <access_token>' \  -H 'Idempotency-Key: <unique_key>' \  -H 'Content-Type: application/json' \  -d '{  "status": "published"}'
Example Response
{  "data": {    "id": "string",    "itemId": "string",    "itemTitle": "string",    "authorName": "string",    "rating": 1,    "body": "string",    "verified": true,    "status": "published",    "reply": null,    "createdAt": 0  }}

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.

The setup checklist: the ordered steps from nothing to a live shop GET

Access: OAuth scope `store:read`; not write-gated.