Coveo Commerce API — Facet Field Configurations

naftiko: 1.0.0-alpha2
info:
  label: Coveo Commerce API — Facet Field Configurations
  description: 'Coveo Commerce API — Facet Field Configurations. 3 operations. Lead operation: Retrieves All Facet Fields.
    Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Commerce
  - Facet Field 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-facet-field-configurations
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Commerce API — Facet Field Configurations business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: rest-organizations-organizationId-commerce-v2-tracking-ids-trackingId-facet-fiel
      path: /rest/organizations/{organizationId}/commerce/v2/tracking-ids/{trackingId}/facet/fields
      operations:
      - name: getall1
        method: GET
        description: Retrieves All Facet Fields
        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: path
          type: string
          description: The unique identifier of the tracking target.
          required: true
        - name: page
          in: query
          type: integer
          description: The 0-based index number of the page to retrieve.
        - name: perPage
          in: query
          type: integer
          description: The number of items to return per page.
    - name: rest-organizations-organizationId-commerce-v2-tracking-ids-trackingId-facet-fiel
      path: /rest/organizations/{organizationId}/commerce/v2/tracking-ids/{trackingId}/facet/fields/bulk-create
      operations:
      - name: bulkcreate
        method: POST
        description: Creates Multiple Facet Fields
        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: path
          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-tracking-ids-trackingId-facet-fiel
      path: /rest/organizations/{organizationId}/commerce/v2/tracking-ids/{trackingId}/facet/fields/bulk-update
      operations:
      - name: bulkupdate
        method: PUT
        description: Update Multiple Facet Fields
        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: path
          type: string
          description: The unique identifier of the tracking target.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: commerce-facet-field-configurations-rest
    port: 8080
    description: REST adapter for Coveo Commerce API — Facet Field Configurations. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/commerce/v2/tracking-ids/{trackingid}/facet/fields
      name: rest-organizations-organizationid-commerce-v2-tracking-ids-trackingid-facet-fiel
      description: REST surface for rest-organizations-organizationId-commerce-v2-tracking-ids-trackingId-facet-fiel.
      operations:
      - method: GET
        name: getall1
        description: Retrieves All Facet Fields
        call: commerce-facet-field-configurations.getall1
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          page: rest.page
          perPage: rest.perPage
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/commerce/v2/tracking-ids/{trackingid}/facet/fields/bulk-create
      name: rest-organizations-organizationid-commerce-v2-tracking-ids-trackingid-facet-fiel
      description: REST surface for rest-organizations-organizationId-commerce-v2-tracking-ids-trackingId-facet-fiel.
      operations:
      - method: POST
        name: bulkcreate
        description: Creates Multiple Facet Fields
        call: commerce-facet-field-configurations.bulkcreate
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/commerce/v2/tracking-ids/{trackingid}/facet/fields/bulk-update
      name: rest-organizations-organizationid-commerce-v2-tracking-ids-trackingid-facet-fiel
      description: REST surface for rest-organizations-organizationId-commerce-v2-tracking-ids-trackingId-facet-fiel.
      operations:
      - method: PUT
        name: bulkupdate
        description: Update Multiple Facet Fields
        call: commerce-facet-field-configurations.bulkupdate
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: commerce-facet-field-configurations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Commerce API — Facet Field Configurations. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: retrieves-all-facet-fields
      description: Retrieves All Facet Fields
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-facet-field-configurations.getall1
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        page: tools.page
        perPage: tools.perPage
      outputParameters:
      - type: object
        mapping: $.
    - name: creates-multiple-facet-fields
      description: Creates Multiple Facet Fields
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: commerce-facet-field-configurations.bulkcreate
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-multiple-facet-fields
      description: Update Multiple Facet Fields
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: commerce-facet-field-configurations.bulkupdate
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.