snapcasterDevelopers

    API reference · Types

    ReviewScore

    The review score and the number of ratings used to calculate it. Display both so readers can judge the sample size. Calculated for each request. A store with no reviews returns { score: null, count: 0 }, as does a manual store, which cannot receive reviews in v1. Used on the seller page and product offers.

    Type: object

    Example

    Schema example: from the GET /products/{productId} response
    {
  "score": 4.93,
  "count": 15
}

    Fields

    score number or null required

    The mean of current, non-hidden ratings, rounded to two decimals. Null when the store has no reviews.

    Example 4.93

    count integer required

    The number of current, non-hidden reviews included in the mean.

    Example 15

    Used by