> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gomarketbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a supplier's average rating and review count

> This supplier's star rating and how many reviews it is based on, read from the aggregate maintained in the same atomic write that records each review.

This is the endpoint to use for a rating badge. `GET /reviews?supplierId=…` returns individual reviews and exposes no average, so computing a rating from it means paging through every review that supplier has ever received — averaging the first page gives a wrong number. That is no longer necessary.

`averageRating` is rounded to one decimal place. A supplier nobody has reviewed returns `averageRating: 0` and `reviewCount: 0`, **not** 404 — a 404 here means the supplier id is unknown in this project.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/projects/{projectId}/suppliers/{supplierId}/review-summary
openapi: 3.0.0
info:
  title: MarketBox 2.0 Open API
  version: 1.0.0
  description: >-
    The MarketBox public API for building booking experiences. Core model:
    create an order, then draw its order items down into bookings. Single
    bookings reference an order item per service line; package bookings draw one
    PACKAGE item down across N sessions. To schedule a package, build a slate
    (POST /availability/package-slate) and book it by slateId (POST
    /orders/{orderId}/package-bookings). See the guides for end-to-end
    walkthroughs.
  contact:
    name: MarketBox support
servers:
  - url: https://apiv2.gomarketbox.com
    description: MarketBox Open API
security:
  - ApiKeyAuth: []
paths:
  /v1/projects/{projectId}/suppliers/{supplierId}/review-summary:
    get:
      tags:
        - Reviews
      summary: Get a supplier's average rating and review count
      description: >-
        This supplier's star rating and how many reviews it is based on, read
        from the aggregate maintained in the same atomic write that records each
        review.


        This is the endpoint to use for a rating badge. `GET
        /reviews?supplierId=…` returns individual reviews and exposes no
        average, so computing a rating from it means paging through every review
        that supplier has ever received — averaging the first page gives a wrong
        number. That is no longer necessary.


        `averageRating` is rounded to one decimal place. A supplier nobody has
        reviewed returns `averageRating: 0` and `reviewCount: 0`, **not** 404 —
        a 404 here means the supplier id is unknown in this project.
      parameters:
        - schema:
            type: string
            minLength: 1
            description: >-
              The project (tenant) that owns the resource. Every resource in
              this API is scoped to a project, and your API key is restricted to
              the projects it was issued for — a project outside that scope
              returns 403.
            example: prj_01kv60qgnef2kt3pvqgwmkbzfr
          required: true
          description: >-
            The project (tenant) that owns the resource. Every resource in this
            API is scoped to a project, and your API key is restricted to the
            projects it was issued for — a project outside that scope returns
            403.
          name: projectId
          in: path
        - schema:
            type: string
            minLength: 1
            description: The supplier — the person or resource delivering the service.
            example: sup_01kv60qh1k5xylm7r0c1qj8zpa
          required: true
          description: The supplier — the person or resource delivering the service.
          name: supplierId
          in: path
      responses:
        '200':
          description: Supplier rating summary
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      supplierId:
                        type: string
                      averageRating:
                        type: number
                      reviewCount:
                        type: integer
                    required:
                      - supplierId
                      - averageRating
                      - reviewCount
                required:
                  - data
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: API key cannot access this project
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Supplier not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
components:
  schemas:
    ErrorMessage:
      type: object
      properties:
        code:
          type: string
          description: Stable machine-readable error code, e.g. NOT_FOUND.
        message:
          type: string
          description: Human-readable description of what went wrong.
        statusCode:
          type: integer
          description: The HTTP status code of this response.
        requestId:
          type: string
          description: >-
            The id of this request, also returned as the X-Request-Id header.
            Quote it in a support ticket.
      required:
        - code
        - message
        - statusCode
        - requestId
      example:
        code: NOT_FOUND
        message: Booking not found
        statusCode: 404
        requestId: a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key minted in the MarketBox dashboard. Scope is restricted to the
        projects you select at creation time. Every route needs the key's
        standard API access (`*`) except `POST /v1/projects/{projectId}/events`,
        which needs `events:write`; a key without `*` is refused with 403
        `CAPABILITY_NOT_GRANTED`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.