Reviewable - Short Format

If you pass the parameter format=short to the reviewable endpoint you will be provided with a short set of key values for the reviewable, including the review count and average score.

Request

GET /v4/organisations/:trkref/reviewable?locale=:locale&sku=:sku&format=:format

This URL: /v4/organisations;trkref=D10/reviewables;locale=en-GB;sku=AIPTPDV5700?format=short is deprecated. Please switch to the current URL above.

Parameters

Parameter Requirement Description
trkref mandatory  
branch_code optional  
locale optional  
sku optional  
format optional Allowed values: short

Response

Attributes

Attribute Description
sku the sku of the reviewable
review_count number of published reviews associated to the reviewable
average_score average score associated to this reviewable

Example

GET /v4/organisations/D10/reviewable?locale=en-GB&sku=AIPTPDV5700&format=short

{
   "sku":"AIPTPDV5700",
   "review_count":0,
   "average_score":"0"
}