VTex Intelligent Search API — Product List Page

naftiko: 1.0.0-alpha2
info:
  label: VTex Intelligent Search API — Product List Page
  description: 'VTex Intelligent Search API — Product List Page. 4 operations. Lead operation: VTex Get list of banners registered
    for query. Self-contained Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Product List Page
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: intelligent-search-product-list-page
    baseUri: https://{accountName}.{environment}.com.br/api/io/_v/api/intelligent-search
    description: VTex Intelligent Search API — Product List Page business capability. Self-contained, no shared references.
    resources:
    - name: banners-facets
      path: /banners/{facets}
      operations:
      - name: get
        method: GET
        description: VTex Get list of banners registered for query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: correction_search
      path: /correction_search
      operations:
      - name: get
        method: GET
        description: VTex Get attempt of correction of a misspelled term
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: facets-facets
      path: /facets/{facets}
      operations:
      - name: get
        method: GET
        description: VTex Get list of the possible facets for a given query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: product_search-facets
      path: /product_search/{facets}
      operations:
      - name: get
        method: GET
        description: VTex Get list of products for a query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: simulationBehavior
          in: query
          type: string
          description: Defines the simulation behavior.
        - name: count
          in: query
          type: number
          description: Number of products per page.
        - name: page
          in: query
          type: number
          description: Current search page.
        - name: sort
          in: query
          type: string
          description: "Defines the sort type. The possible values are: \r"
  exposes:
  - type: rest
    namespace: intelligent-search-product-list-page-rest
    port: 8080
    description: REST adapter for VTex Intelligent Search API — Product List Page. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/banners/{facets}
      name: banners-facets
      description: REST surface for banners-facets.
      operations:
      - method: GET
        name: get
        description: VTex Get list of banners registered for query
        call: intelligent-search-product-list-page.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/correction-search
      name: correction-search
      description: REST surface for correction_search.
      operations:
      - method: GET
        name: get
        description: VTex Get attempt of correction of a misspelled term
        call: intelligent-search-product-list-page.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/facets/{facets}
      name: facets-facets
      description: REST surface for facets-facets.
      operations:
      - method: GET
        name: get
        description: VTex Get list of the possible facets for a given query
        call: intelligent-search-product-list-page.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/product-search/{facets}
      name: product-search-facets
      description: REST surface for product_search-facets.
      operations:
      - method: GET
        name: get
        description: VTex Get list of products for a query
        call: intelligent-search-product-list-page.get
        with:
          simulationBehavior: rest.simulationBehavior
          count: rest.count
          page: rest.page
          sort: rest.sort
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: intelligent-search-product-list-page-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Intelligent Search API — Product List Page. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: vtex-get-list-banners-registered
      description: VTex Get list of banners registered for query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: intelligent-search-product-list-page.get
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-attempt-correction-misspelled
      description: VTex Get attempt of correction of a misspelled term
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: intelligent-search-product-list-page.get
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-list-possible-facets
      description: VTex Get list of the possible facets for a given query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: intelligent-search-product-list-page.get
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-list-products-query
      description: VTex Get list of products for a query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: intelligent-search-product-list-page.get
      with:
        simulationBehavior: tools.simulationBehavior
        count: tools.count
        page: tools.page
        sort: tools.sort
      outputParameters:
      - type: object
        mapping: $.