Shopper Approved API — Reviews

naftiko: 1.0.0-alpha2
info:
  label: Shopper Approved API — Reviews
  description: 'Shopper Approved API — Reviews. 3 operations. Lead operation: List Reviews. Self-contained Naftiko capability
    covering one Shopper Approved business surface.'
  tags:
  - Shopper Approved
  - Reviews
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHOPPER_APPROVED_API_KEY: SHOPPER_APPROVED_API_KEY
capability:
  consumes:
  - type: http
    namespace: shopper-approved-reviews
    baseUri: https://api.shopperapproved.com
    description: Shopper Approved API — Reviews business capability. Self-contained, no shared references.
    resources:
    - name: reviews-site_id
      path: /reviews/{site_id}
      operations:
      - name: listreviews
        method: GET
        description: List Reviews
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: site_id
          in: path
          type: string
          description: Your Shopper Approved site ID
          required: true
        - name: token
          in: query
          type: string
          description: Your Shopper Approved API token
          required: true
        - name: from
          in: query
          type: string
          description: Start date for reviews (defaults to last 30 days if not specified)
        - name: limit
          in: query
          type: integer
          description: Maximum number of reviews to return
        - name: page
          in: query
          type: integer
          description: Page number for pagination
    - name: reviews-site_id-review_id
      path: /reviews/{site_id}/{review_id}
      operations:
      - name: getreview
        method: GET
        description: Get Review
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: site_id
          in: path
          type: string
          description: Your Shopper Approved site ID
          required: true
        - name: review_id
          in: path
          type: string
          description: The order ID of the review to retrieve
          required: true
        - name: token
          in: query
          type: string
          description: Your Shopper Approved API token
          required: true
    - name: reviews-site_id-review_id-update
      path: /reviews/{site_id}/{review_id}/update
      operations:
      - name: updatereview
        method: PUT
        description: Update Review
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: site_id
          in: path
          type: string
          description: Your Shopper Approved site ID
          required: true
        - name: review_id
          in: path
          type: string
          description: The order ID of the review to update
          required: true
        - name: token
          in: query
          type: string
          description: Your Shopper Approved API token
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: token
      value: '{{env.SHOPPER_APPROVED_API_KEY}}'
      placement: query
  exposes:
  - type: rest
    namespace: shopper-approved-reviews-rest
    port: 8080
    description: REST adapter for Shopper Approved API — Reviews. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/reviews/{site-id}
      name: reviews-site-id
      description: REST surface for reviews-site_id.
      operations:
      - method: GET
        name: listreviews
        description: List Reviews
        call: shopper-approved-reviews.listreviews
        with:
          site_id: rest.site_id
          token: rest.token
          from: rest.from
          limit: rest.limit
          page: rest.page
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/reviews/{site-id}/{review-id}
      name: reviews-site-id-review-id
      description: REST surface for reviews-site_id-review_id.
      operations:
      - method: GET
        name: getreview
        description: Get Review
        call: shopper-approved-reviews.getreview
        with:
          site_id: rest.site_id
          review_id: rest.review_id
          token: rest.token
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/reviews/{site-id}/{review-id}/update
      name: reviews-site-id-review-id-update
      description: REST surface for reviews-site_id-review_id-update.
      operations:
      - method: PUT
        name: updatereview
        description: Update Review
        call: shopper-approved-reviews.updatereview
        with:
          site_id: rest.site_id
          review_id: rest.review_id
          token: rest.token
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shopper-approved-reviews-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shopper Approved API — Reviews. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-reviews
      description: List Reviews
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopper-approved-reviews.listreviews
      with:
        site_id: tools.site_id
        token: tools.token
        from: tools.from
        limit: tools.limit
        page: tools.page
      outputParameters:
      - type: object
        mapping: $.
    - name: get-review
      description: Get Review
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shopper-approved-reviews.getreview
      with:
        site_id: tools.site_id
        review_id: tools.review_id
        token: tools.token
      outputParameters:
      - type: object
        mapping: $.
    - name: update-review
      description: Update Review
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: shopper-approved-reviews.updatereview
      with:
        site_id: tools.site_id
        review_id: tools.review_id
        token: tools.token
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.