Coveo Commerce API — Search

naftiko: 1.0.0-alpha2
info:
  label: Coveo Commerce API — Search
  description: 'Coveo Commerce API — Search. 4 operations. Lead operation: Execute a Search Query. Self-contained Naftiko
    capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Commerce
  - Search
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_SEARCH_TOKEN: COVEO_SEARCH_TOKEN
capability:
  consumes:
  - type: http
    namespace: commerce-search
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Commerce API — Search business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: rest-organizations-organizationId-commerce-v2-search
      path: /rest/organizations/{organizationId}/commerce/v2/search
      operations:
      - name: search
        method: POST
        description: Execute a Search Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `acmecorporation8tp8wu3`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-commerce-v2-search-productSuggest
      path: /rest/organizations/{organizationId}/commerce/v2/search/productSuggest
      operations:
      - name: productsuggest
        method: POST
        description: Request Product Suggestions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `acmecorporation8tp8wu3`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-commerce-v2-search-querySuggest
      path: /rest/organizations/{organizationId}/commerce/v2/search/querySuggest
      operations:
      - name: querysuggest
        method: POST
        description: Request Query Suggestions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `acmecorporation8tp8wu3`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-commerce-v2-search-redirect
      path: /rest/organizations/{organizationId}/commerce/v2/search/redirect
      operations:
      - name: redirect
        method: POST
        description: Execute a Search Redirect Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `acmecorporation8tp8wu3`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: commerce-search-rest
    port: 8080
    description: REST adapter for Coveo Commerce API — Search. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/commerce/v2/search
      name: rest-organizations-organizationid-commerce-v2-search
      description: REST surface for rest-organizations-organizationId-commerce-v2-search.
      operations:
      - method: POST
        name: search
        description: Execute a Search Query
        call: commerce-search.search
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/commerce/v2/search/productsuggest
      name: rest-organizations-organizationid-commerce-v2-search-productsuggest
      description: REST surface for rest-organizations-organizationId-commerce-v2-search-productSuggest.
      operations:
      - method: POST
        name: productsuggest
        description: Request Product Suggestions
        call: commerce-search.productsuggest
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/commerce/v2/search/querysuggest
      name: rest-organizations-organizationid-commerce-v2-search-querysuggest
      description: REST surface for rest-organizations-organizationId-commerce-v2-search-querySuggest.
      operations:
      - method: POST
        name: querysuggest
        description: Request Query Suggestions
        call: commerce-search.querysuggest
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/commerce/v2/search/redirect
      name: rest-organizations-organizationid-commerce-v2-search-redirect
      description: REST surface for rest-organizations-organizationId-commerce-v2-search-redirect.
      operations:
      - method: POST
        name: redirect
        description: Execute a Search Redirect Query
        call: commerce-search.redirect
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: commerce-search-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Commerce API — Search. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: execute-search-query
      description: Execute a Search Query
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: commerce-search.search
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: request-product-suggestions
      description: Request Product Suggestions
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: commerce-search.productsuggest
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: request-query-suggestions
      description: Request Query Suggestions
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: commerce-search.querysuggest
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: execute-search-redirect-query
      description: Execute a Search Redirect Query
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: commerce-search.redirect
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.