naftiko: 1.0.0-alpha2
info:
label: Coveo Commerce API — Search Configurations
description: 'Coveo Commerce API — Search Configurations. 2 operations. Lead operation: Retrieves the Global Search Configuration
for the Organization. Self-contained Naftiko capability covering one Coveo business surface.'
tags:
- Coveo
- Commerce
- Search 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-search-configurations
baseUri: https://platform.cloud.coveo.com
description: Coveo Commerce API — Search Configurations business capability. Self-contained, no shared references.
authentication:
type: bearer
token: '{{env.COVEO_SEARCH_TOKEN}}'
resources:
- name: rest-organizations-organizationId-commerce-v2-configurations-search-global
path: /rest/organizations/{organizationId}/commerce/v2/configurations/search/global
operations:
- name: getglobal
method: GET
description: Retrieves the Global Search Configuration for the Organization
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/).
**Example:**
`acmecorporation8tp8wu3`
required: true
- name: trackingId
in: query
type: string
description: The unique identifier of the tracking target.
required: true
- name: updateglobal
method: PUT
description: Update the Global Search Configuration for the Organization
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/).
**Example:**
`acmecorporation8tp8wu3`
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
exposes:
- type: rest
namespace: commerce-search-configurations-rest
port: 8080
description: REST adapter for Coveo Commerce API — Search Configurations. One Spectral-compliant resource per consumed
operation, prefixed with /v1.
resources:
- path: /v1/organizations/{organizationid}/commerce/v2/configurations/search/global
name: rest-organizations-organizationid-commerce-v2-configurations-search-global
description: REST surface for rest-organizations-organizationId-commerce-v2-configurations-search-global.
operations:
- method: GET
name: getglobal
description: Retrieves the Global Search Configuration for the Organization
call: commerce-search-configurations.getglobal
with:
organizationId: rest.organizationId
trackingId: rest.trackingId
outputParameters:
- type: object
mapping: $.
- method: PUT
name: updateglobal
description: Update the Global Search Configuration for the Organization
call: commerce-search-configurations.updateglobal
with:
organizationId: rest.organizationId
body: rest.body
outputParameters:
- type: object
mapping: $.
- type: mcp
namespace: commerce-search-configurations-mcp
port: 9090
transport: http
description: MCP adapter for Coveo Commerce API — Search Configurations. One tool per consumed operation, routed inline
through this capability's consumes block.
tools:
- name: retrieves-global-search-configuration-organization
description: Retrieves the Global Search Configuration for the Organization
hints:
readOnly: true
destructive: false
idempotent: true
call: commerce-search-configurations.getglobal
with:
organizationId: tools.organizationId
trackingId: tools.trackingId
outputParameters:
- type: object
mapping: $.
- name: update-global-search-configuration-organization
description: Update the Global Search Configuration for the Organization
hints:
readOnly: false
destructive: false
idempotent: true
call: commerce-search-configurations.updateglobal
with:
organizationId: tools.organizationId
body: tools.body
outputParameters:
- type: object
mapping: $.