Coveo Commerce API — Synonym

naftiko: 1.0.0-alpha2
info:
  label: Coveo Commerce API — Synonym
  description: 'Coveo Commerce API — Synonym. 5 operations. Lead operation: List Synonym Rules. Self-contained Naftiko capability
    covering one Coveo business surface.'
  tags:
  - Coveo
  - Commerce
  - Synonym
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_SEARCH_TOKEN: COVEO_SEARCH_TOKEN
capability:
  consumes:
  - type: http
    namespace: commerce-synonym
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Commerce API — Synonym business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: rest-organizations-organizationId-commerce-v2-search-synonyms
      path: /rest/organizations/{organizationId}/commerce/v2/search/synonyms
      operations:
      - name: listsynonyms
        method: GET
        description: List Synonym Rules
        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: language
          in: query
          type: string
          description: An ISO 639-1 language code.
        - name: country
          in: query
          type: string
          description: An ISO 3166-1 alpha-2 country code.
        - name: currency
          in: query
          type: string
          description: An ISO 4217 currency code.
        - name: query
          in: query
          type: string
          description: Filter on search term (query expression) when requesting rules.
        - name: action
          in: query
          type: string
          description: 'The synonym rule type. Possible values are: one-way, two-way, and one-way-reverse.'
        - name: sort
          in: query
          type: string
          description: property.direction to sort by.
        - name: page
          in: query
          type: integer
          description: The 0-based index number of the page of rules to retrieve.</br>**Minimum:** `0`</br>**Default:** `0`
        - name: perPage
          in: query
          type: integer
          description: The number of rules to list per page.</br>**Minimum:** `1`</br>**Maximum:** `1000`</br>**Default:**
            `10`
      - name: createsynonym
        method: POST
        description: Create a Synonym Rule
        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: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-commerce-v2-search-synonyms-synonymId
      path: /rest/organizations/{organizationId}/commerce/v2/search/synonyms/{synonymId}
      operations:
      - name: getsynonym
        method: GET
        description: Get a Synonym Rule.
        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: synonymId
          in: path
          type: string
          description: A UUID identifying the synonym rule.
          required: true
      - name: editsynonym
        method: PUT
        description: Edit Synonym Rule
        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: synonymId
          in: path
          type: string
          description: A UUID identifying the synonym rule.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletesynonym
        method: DELETE
        description: Delete Synonym Rule.
        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: synonymId
          in: path
          type: string
          description: A UUID identifying the synonym rule.
          required: true
  exposes:
  - type: rest
    namespace: commerce-synonym-rest
    port: 8080
    description: REST adapter for Coveo Commerce API — Synonym. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/commerce/v2/search/synonyms
      name: rest-organizations-organizationid-commerce-v2-search-synonyms
      description: REST surface for rest-organizations-organizationId-commerce-v2-search-synonyms.
      operations:
      - method: GET
        name: listsynonyms
        description: List Synonym Rules
        call: commerce-synonym.listsynonyms
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          language: rest.language
          country: rest.country
          currency: rest.currency
          query: rest.query
          action: rest.action
          sort: rest.sort
          page: rest.page
          perPage: rest.perPage
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsynonym
        description: Create a Synonym Rule
        call: commerce-synonym.createsynonym
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/commerce/v2/search/synonyms/{synonymid}
      name: rest-organizations-organizationid-commerce-v2-search-synonyms-synonymid
      description: REST surface for rest-organizations-organizationId-commerce-v2-search-synonyms-synonymId.
      operations:
      - method: GET
        name: getsynonym
        description: Get a Synonym Rule.
        call: commerce-synonym.getsynonym
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          synonymId: rest.synonymId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: editsynonym
        description: Edit Synonym Rule
        call: commerce-synonym.editsynonym
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          synonymId: rest.synonymId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesynonym
        description: Delete Synonym Rule.
        call: commerce-synonym.deletesynonym
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          synonymId: rest.synonymId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: commerce-synonym-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Commerce API — Synonym. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-synonym-rules
      description: List Synonym Rules
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-synonym.listsynonyms
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        language: tools.language
        country: tools.country
        currency: tools.currency
        query: tools.query
        action: tools.action
        sort: tools.sort
        page: tools.page
        perPage: tools.perPage
      outputParameters:
      - type: object
        mapping: $.
    - name: create-synonym-rule
      description: Create a Synonym Rule
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: commerce-synonym.createsynonym
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-synonym-rule
      description: Get a Synonym Rule.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-synonym.getsynonym
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        synonymId: tools.synonymId
      outputParameters:
      - type: object
        mapping: $.
    - name: edit-synonym-rule
      description: Edit Synonym Rule
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: commerce-synonym.editsynonym
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        synonymId: tools.synonymId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-synonym-rule
      description: Delete Synonym Rule.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: commerce-synonym.deletesynonym
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        synonymId: tools.synonymId
      outputParameters:
      - type: object
        mapping: $.