VTex Reviews and Ratings API — Rating

naftiko: 1.0.0-alpha2
info:
  label: VTex Reviews and Ratings API — Rating
  description: 'VTex Reviews and Ratings API — Rating. 1 operations. Lead operation: VTex Get product rating. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Rating
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: reviews-ratings-rating
    baseUri: https://{accountName}.myvtex.com
    description: VTex Reviews and Ratings API — Rating business capability. Self-contained, no shared references.
    resources:
    - name: reviews-and-ratings-api-rating-productId
      path: /reviews-and-ratings/api/rating/{productId}
      operations:
      - name: getproductrating
        method: GET
        description: VTex Get product rating
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: productId
          in: path
          type: string
          description: Product ID.
          required: true
        - name: Content-Type
          in: header
          type: string
          description: Describes the type of the content being sent.
          required: true
        - name: Accept
          in: header
          type: string
          description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: reviews-ratings-rating-rest
    port: 8080
    description: REST adapter for VTex Reviews and Ratings API — Rating. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/reviews-and-ratings/api/rating/{productid}
      name: reviews-and-ratings-api-rating-productid
      description: REST surface for reviews-and-ratings-api-rating-productId.
      operations:
      - method: GET
        name: getproductrating
        description: VTex Get product rating
        call: reviews-ratings-rating.getproductrating
        with:
          productId: rest.productId
          Content-Type: rest.Content-Type
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: reviews-ratings-rating-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Reviews and Ratings API — Rating. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-get-product-rating
      description: VTex Get product rating
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: reviews-ratings-rating.getproductrating
      with:
        productId: tools.productId
        Content-Type: tools.Content-Type
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.