Returns the reviews that meet the given conditions.
HTTP POST/api/v10/storefront.reviews
{
"conditions" : { // returns only the reviews …
"code" : "NS1208", // … with this code - string(1…32)
"type" : "Product", // … of this type, can be "Merchant" or "Product" - string
"products" : [ 281, 290, … ], // … of these products (id) (can be null) - int(1…)
"language" : "en" // … in this language (ISO code) - string(2)
},
"fields" : [ "code", "type", … ], // fields to return - string
"limit" : 10, // maximum number of reviews to return - int(1…)
"first" : 0 // index of the first review to return - int(0…)
}
{
"status" : "ok",
"reviews" : [ {
"code" : "NS1208", // code - string(1…32)
"type" : "Product", // type, can be "Merchant" or "Product" - string
"product" : 281, // product (id) (can be null) - int(1…)
"date" : "2020-09-01 12:39:07", // date - datetime
"author" : "Bob", // author name - string(0…60)
"language" : "en", // language (ISO code) - string(2)
"rating" : 4.5, // rating - decimal[2,1](0…5)
"summary" : "Excellent product", // summary - string(0…255)
"content" : "…" // content - string(0…64000)
}, … ],
"count" : 371 // total number of review that meet the given conditions - int(0…)
}
Field | Type | Description |
---|---|---|
products | InvalidValue | products must be null if type is "Merchant" |