Coveo Commerce API — Query Configurations

naftiko: 1.0.0-alpha2
info:
  label: Coveo Commerce API — Query Configurations
  description: 'Coveo Commerce API — Query Configurations. 4 operations. Lead operation: Get Query Configuration for a Solution.
    Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Commerce
  - Query 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-query-configurations
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Commerce API — Query Configurations business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: rest-organizations-organizationId-commerce-v2-configurations-query
      path: /rest/organizations/{organizationId}/commerce/v2/configurations/query
      operations:
      - name: get1
        method: GET
        description: Get Query Configuration for a Solution
        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: The unique identifier of the tracking target.
          required: true
        - name: solutionType
          in: query
          type: string
          description: The solution type for the rule. It can be either 'listing' or 'search' or 'recommendations'.
          required: true
        - name: targets
          in: query
          type: array
          description: List of target identifiers e.g. listing page name, slot ID
        - name: isGlobal
          in: query
          type: boolean
          description: Whether the query configuration is globally applied.
      - name: update1
        method: PUT
        description: Update Query Configuration for a Solution
        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: create
        method: POST
        description: Create Query Configuration for a Solution
        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: delete1
        method: DELETE
        description: Delete the Query Configuration of a Solution
        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: The unique identifier of the tracking target.
          required: true
        - name: solutionType
          in: query
          type: string
          description: The solution type for the rule. It can be either 'listing' or 'search' or 'recommendations'.
          required: true
        - name: targets
          in: query
          type: array
          description: List of target identifiers e.g. listing page name, slot ID
        - name: isGlobal
          in: query
          type: boolean
          description: Whether the query configuration is globally applied.
  exposes:
  - type: rest
    namespace: commerce-query-configurations-rest
    port: 8080
    description: REST adapter for Coveo Commerce API — Query Configurations. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/commerce/v2/configurations/query
      name: rest-organizations-organizationid-commerce-v2-configurations-query
      description: REST surface for rest-organizations-organizationId-commerce-v2-configurations-query.
      operations:
      - method: GET
        name: get1
        description: Get Query Configuration for a Solution
        call: commerce-query-configurations.get1
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          solutionType: rest.solutionType
          targets: rest.targets
          isGlobal: rest.isGlobal
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: update1
        description: Update Query Configuration for a Solution
        call: commerce-query-configurations.update1
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: create
        description: Create Query Configuration for a Solution
        call: commerce-query-configurations.create
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete1
        description: Delete the Query Configuration of a Solution
        call: commerce-query-configurations.delete1
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          solutionType: rest.solutionType
          targets: rest.targets
          isGlobal: rest.isGlobal
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: commerce-query-configurations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Commerce API — Query Configurations. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: get-query-configuration-solution
      description: Get Query Configuration for a Solution
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-query-configurations.get1
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        solutionType: tools.solutionType
        targets: tools.targets
        isGlobal: tools.isGlobal
      outputParameters:
      - type: object
        mapping: $.
    - name: update-query-configuration-solution
      description: Update Query Configuration for a Solution
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: commerce-query-configurations.update1
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: create-query-configuration-solution
      description: Create Query Configuration for a Solution
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: commerce-query-configurations.create
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-query-configuration-solution
      description: Delete the Query Configuration of a Solution
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: commerce-query-configurations.delete1
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        solutionType: tools.solutionType
        targets: tools.targets
        isGlobal: tools.isGlobal
      outputParameters:
      - type: object
        mapping: $.