Reviews. 2 operations.
2 of them work. Each needs a bearer token with its scope. All operations.
Operations
POST/api/v1/reviews/{id}/approvereviews.approvereviews.write
GET/api/v1/reviewsreviews.listreviews.read
Read a page at a time: give limit (1 to 500; 100 when none is given) and after, the Next-Cursor of the page before. Follow the Link, rel next, to the rest.
Parameters
limitquery | integerThe most reviews in the page: 1 to 500; 100 when the call gives no limit. The Next-Cursor and Link headers name the next page. |
afterquery | stringSee common parameters |
Answer
array of Review
Errors: 400, 401, 403, 405, 422, 429
curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/reviews
Schemas 2
Review
Review is a review a buyer wrote through their order's review link: the product and the variant of the order line it is tied to, the order's number, its rating from 1 to 5, the name it shows, its words, when it was written, and when the owner approved it, from which it shows on the product's page.
approved_at | string (date-time) |
atrequired | string (date-time) |
idrequired | integer |
namerequired | string |
orderrequired | integer |
productrequired | string |
ratingrequired | integer |
skurequired | string |
textrequired | string |
ReviewChange
ReviewChange is a review as an operation left it, and whether the operation changed it: a review approved before stays as it was.
changedrequired | boolean |
reviewrequired | Review |
Made from engine/internal/openapi/openapi.json at commit 6c4cbd921. The contract-only operations come from the engine’s stub file, engine/internal/ops.