Coveo Commerce API — Product Suggest Configurations

naftiko: 1.0.0-alpha2
info:
  label: Coveo Commerce API — Product Suggest Configurations
  description: 'Coveo Commerce API — Product Suggest Configurations. 4 operations. Lead operation: Retrieves a Product Suggest
    Configuration. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Commerce
  - Product Suggest Configurations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_SEARCH_TOKEN: COVEO_SEARCH_TOKEN
capability:
  consumes:
  - type: http
    namespace: commerce-product-suggest-configurations
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Commerce API — Product Suggest Configurations business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: rest-organizations-organizationId-commerce-v2-configurations-productSuggest
      path: /rest/organizations/{organizationId}/commerce/v2/configurations/productSuggest
      operations:
      - name: get2
        method: GET
        description: Retrieves a Product Suggest Configuration
        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: trackingId
          in: query
          type: string
          description: Tracking ID of the product suggest configuration
          required: true
      - name: update2
        method: PUT
        description: Update a Product Suggest Configuration
        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: trackingId
          in: query
          type: string
          description: Tracking ID of the product suggest configuration
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: create1
        method: POST
        description: Create a Product Suggest Configuration
        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: delete2
        method: DELETE
        description: Deletes a Product Suggest Configuration
        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: trackingId
          in: query
          type: string
          description: Tracking ID of the product suggest configuration
          required: true
  exposes:
  - type: rest
    namespace: commerce-product-suggest-configurations-rest
    port: 8080
    description: REST adapter for Coveo Commerce API — Product Suggest Configurations. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/commerce/v2/configurations/productsuggest
      name: rest-organizations-organizationid-commerce-v2-configurations-productsuggest
      description: REST surface for rest-organizations-organizationId-commerce-v2-configurations-productSuggest.
      operations:
      - method: GET
        name: get2
        description: Retrieves a Product Suggest Configuration
        call: commerce-product-suggest-configurations.get2
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: update2
        description: Update a Product Suggest Configuration
        call: commerce-product-suggest-configurations.update2
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: create1
        description: Create a Product Suggest Configuration
        call: commerce-product-suggest-configurations.create1
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete2
        description: Deletes a Product Suggest Configuration
        call: commerce-product-suggest-configurations.delete2
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: commerce-product-suggest-configurations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Commerce API — Product Suggest Configurations. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: retrieves-product-suggest-configuration
      description: Retrieves a Product Suggest Configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-product-suggest-configurations.get2
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-product-suggest-configuration
      description: Update a Product Suggest Configuration
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: commerce-product-suggest-configurations.update2
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: create-product-suggest-configuration
      description: Create a Product Suggest Configuration
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: commerce-product-suggest-configurations.create1
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: deletes-product-suggest-configuration
      description: Deletes a Product Suggest Configuration
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: commerce-product-suggest-configurations.delete2
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
      outputParameters:
      - type: object
        mapping: $.