Coveo Commerce API — Listing Configurations

naftiko: 1.0.0-alpha2
info:
  label: Coveo Commerce API — Listing Configurations
  description: 'Coveo Commerce API — Listing Configurations. 10 operations. Lead operation: Retrieves All Listing Configurations
    of an Organization. WILL BE DEPRECATED on 2026-08-31.. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Commerce
  - Listing 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-listing-configurations
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Commerce API — Listing Configurations business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: rest-organizations-organizationId-commerce-v2-configurations-listings
      path: /rest/organizations/{organizationId}/commerce/v2/configurations/listings
      operations:
      - name: getall
        method: GET
        description: Retrieves All Listing Configurations of an Organization. WILL BE DEPRECATED on 2026-08-31.
        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: query
          in: query
          type: string
          description: Filter on names when requesting listing configuration names & IDs. Will perform '*query*' match pattern.
        - name: page
          in: query
          type: integer
          description: The 0-based index number of the page of listing configurations to retrieve.</br>**Minimum:** `0`</br>**Default:**
            `0`
        - name: perPage
          in: query
          type: integer
          description: The number of listing configurations to list per page.</br>**Minimum:** `1`</br>**Maximum:** `1000`</br>**Default:**
            `10`
      - name: create3
        method: POST
        description: Create a Listing Configuration. WILL BE DEPRECATED on 2026-08-31.
        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: rest-organizations-organizationId-commerce-v2-configurations-listings-global
      path: /rest/organizations/{organizationId}/commerce/v2/configurations/listings/global
      operations:
      - name: getglobal1
        method: GET
        description: Retrieves the Global Listing 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/).<br />**Example:**
            `acmecorporation8tp8wu3`
          required: true
        - name: trackingId
          in: query
          type: string
          description: The unique identifier of the tracking target.
          required: true
      - name: updateglobal1
        method: PUT
        description: Update the Global Listing 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/).<br />**Example:**
            `acmecorporation8tp8wu3`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-commerce-v2-configurations-listings-names
      path: /rest/organizations/{organizationId}/commerce/v2/configurations/listings/names
      operations:
      - name: getallnames
        method: GET
        description: Retrieves All Listing Configurations Ids & Names of an Organization. WILL BE DEPRECATED on 2026-08-31.
        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: query
          in: query
          type: string
          description: Filter on names when requesting listing configuration names & IDs. Will perform '*query*' match pattern.
        - name: page
          in: query
          type: integer
          description: The 0-based index number of the page of listing configurations to retrieve.</br>**Minimum:** `0`</br>**Default:**
            `0`
        - name: perPage
          in: query
          type: integer
          description: The number of listing configurations to list per page.</br>**Minimum:** `1`</br>**Maximum:** `1000`</br>**Default:**
            `10`
    - name: rest-organizations-organizationId-commerce-v2-configurations-listings-rules
      path: /rest/organizations/{organizationId}/commerce/v2/configurations/listings/rules
      operations:
      - name: getrules
        method: GET
        description: Retrieves All Rules Related to Listings of an Organization. WILL BE DEPRECATED on 2026-08-31.
        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: configurationId
          in: query
          type: string
          description: The unique identifier of the listing configuration.
        - name: name
          in: query
          type: string
          description: Filter on rule name when requesting rules.
        - name: scope
          in: query
          type: string
          description: 'Rule scope to return. One of: [specific, global]. Returns all if not specified.'
        - name: essential
          in: query
          type: boolean
          description: Indicates if the rule is essential to the listing page; the essential rule is added during page creation.
            Returns all rules if not specified.
        - 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: actions
          in: query
          type: array
          description: 'Rule action type to return. One of: [boost, bury, pin, include, exclude, onlyShow]. Returns all if
            not specified.'
        - name: sort
          in: query
          type: array
          description: List of property.direction to sort by
        - name: scheduleFilter
          in: query
          type: string
          description: The schedule filter to apply.
        - 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: rest-organizations-organizationId-commerce-v2-configurations-listings-url
      path: /rest/organizations/{organizationId}/commerce/v2/configurations/listings/url
      operations:
      - name: getbyurl
        method: GET
        description: Retrieves a Listing Configuration by Its Matching Url. WILL BE DEPRECATED on 2026-08-31.
        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: url
          in: query
          type: string
          description: URL
          required: true
    - name: rest-organizations-organizationId-commerce-v2-configurations-listings-configurat
      path: /rest/organizations/{organizationId}/commerce/v2/configurations/listings/{configurationId}
      operations:
      - name: get3
        method: GET
        description: Retrieves a Listing Configuration. WILL BE DEPRECATED on 2026-08-31.
        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: configurationId
          in: path
          type: string
          description: The unique identifier of the listing configuration.
          required: true
      - name: update3
        method: PUT
        description: Update a Listing Configuration. WILL BE DEPRECATED on 2026-08-31.
        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: configurationId
          in: path
          type: string
          description: The unique identifier of the listing configuration.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: delete3
        method: DELETE
        description: Deletes a Listing Configuration. WILL BE DEPRECATED on 2026-08-31.
        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: configurationId
          in: path
          type: string
          description: The unique identifier of the listing configuration.
          required: true
  exposes:
  - type: rest
    namespace: commerce-listing-configurations-rest
    port: 8080
    description: REST adapter for Coveo Commerce API — Listing Configurations. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/commerce/v2/configurations/listings
      name: rest-organizations-organizationid-commerce-v2-configurations-listings
      description: REST surface for rest-organizations-organizationId-commerce-v2-configurations-listings.
      operations:
      - method: GET
        name: getall
        description: Retrieves All Listing Configurations of an Organization. WILL BE DEPRECATED on 2026-08-31.
        call: commerce-listing-configurations.getall
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          query: rest.query
          page: rest.page
          perPage: rest.perPage
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: create3
        description: Create a Listing Configuration. WILL BE DEPRECATED on 2026-08-31.
        call: commerce-listing-configurations.create3
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/commerce/v2/configurations/listings/global
      name: rest-organizations-organizationid-commerce-v2-configurations-listings-global
      description: REST surface for rest-organizations-organizationId-commerce-v2-configurations-listings-global.
      operations:
      - method: GET
        name: getglobal1
        description: Retrieves the Global Listing Configuration for the Organization
        call: commerce-listing-configurations.getglobal1
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateglobal1
        description: Update the Global Listing Configuration for the Organization
        call: commerce-listing-configurations.updateglobal1
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/commerce/v2/configurations/listings/names
      name: rest-organizations-organizationid-commerce-v2-configurations-listings-names
      description: REST surface for rest-organizations-organizationId-commerce-v2-configurations-listings-names.
      operations:
      - method: GET
        name: getallnames
        description: Retrieves All Listing Configurations Ids & Names of an Organization. WILL BE DEPRECATED on 2026-08-31.
        call: commerce-listing-configurations.getallnames
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          query: rest.query
          page: rest.page
          perPage: rest.perPage
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/commerce/v2/configurations/listings/rules
      name: rest-organizations-organizationid-commerce-v2-configurations-listings-rules
      description: REST surface for rest-organizations-organizationId-commerce-v2-configurations-listings-rules.
      operations:
      - method: GET
        name: getrules
        description: Retrieves All Rules Related to Listings of an Organization. WILL BE DEPRECATED on 2026-08-31.
        call: commerce-listing-configurations.getrules
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          configurationId: rest.configurationId
          name: rest.name
          scope: rest.scope
          essential: rest.essential
          language: rest.language
          country: rest.country
          currency: rest.currency
          actions: rest.actions
          sort: rest.sort
          scheduleFilter: rest.scheduleFilter
          page: rest.page
          perPage: rest.perPage
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/commerce/v2/configurations/listings/url
      name: rest-organizations-organizationid-commerce-v2-configurations-listings-url
      description: REST surface for rest-organizations-organizationId-commerce-v2-configurations-listings-url.
      operations:
      - method: GET
        name: getbyurl
        description: Retrieves a Listing Configuration by Its Matching Url. WILL BE DEPRECATED on 2026-08-31.
        call: commerce-listing-configurations.getbyurl
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          url: rest.url
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/commerce/v2/configurations/listings/{configurationid}
      name: rest-organizations-organizationid-commerce-v2-configurations-listings-configurat
      description: REST surface for rest-organizations-organizationId-commerce-v2-configurations-listings-configurat.
      operations:
      - method: GET
        name: get3
        description: Retrieves a Listing Configuration. WILL BE DEPRECATED on 2026-08-31.
        call: commerce-listing-configurations.get3
        with:
          organizationId: rest.organizationId
          configurationId: rest.configurationId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: update3
        description: Update a Listing Configuration. WILL BE DEPRECATED on 2026-08-31.
        call: commerce-listing-configurations.update3
        with:
          organizationId: rest.organizationId
          configurationId: rest.configurationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete3
        description: Deletes a Listing Configuration. WILL BE DEPRECATED on 2026-08-31.
        call: commerce-listing-configurations.delete3
        with:
          organizationId: rest.organizationId
          configurationId: rest.configurationId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: commerce-listing-configurations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Commerce API — Listing Configurations. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: retrieves-all-listing-configurations-organization
      description: Retrieves All Listing Configurations of an Organization. WILL BE DEPRECATED on 2026-08-31.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-listing-configurations.getall
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        query: tools.query
        page: tools.page
        perPage: tools.perPage
      outputParameters:
      - type: object
        mapping: $.
    - name: create-listing-configuration-will-be
      description: Create a Listing Configuration. WILL BE DEPRECATED on 2026-08-31.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: commerce-listing-configurations.create3
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-global-listing-configuration-organization
      description: Retrieves the Global Listing Configuration for the Organization
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-listing-configurations.getglobal1
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-global-listing-configuration-organization
      description: Update the Global Listing Configuration for the Organization
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: commerce-listing-configurations.updateglobal1
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-all-listing-configurations-ids
      description: Retrieves All Listing Configurations Ids & Names of an Organization. WILL BE DEPRECATED on 2026-08-31.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-listing-configurations.getallnames
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        query: tools.query
        page: tools.page
        perPage: tools.perPage
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-all-rules-related-listings
      description: Retrieves All Rules Related to Listings of an Organization. WILL BE DEPRECATED on 2026-08-31.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-listing-configurations.getrules
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        configurationId: tools.configurationId
        name: tools.name
        scope: tools.scope
        essential: tools.essential
        language: tools.language
        country: tools.country
        currency: tools.currency
        actions: tools.actions
        sort: tools.sort
        scheduleFilter: tools.scheduleFilter
        page: tools.page
        perPage: tools.perPage
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-listing-configuration-its-matching
      description: Retrieves a Listing Configuration by Its Matching Url. WILL BE DEPRECATED on 2026-08-31.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-listing-configurations.getbyurl
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        url: tools.url
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-listing-configuration-will-be
      description: Retrieves a Listing Configuration. WILL BE DEPRECATED on 2026-08-31.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-listing-configurations.get3
      with:
        organizationId: tools.organizationId
        configurationId: tools.configurationId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-listing-configuration-will-be
      description: Update a Listing Configuration. WILL BE DEPRECATED on 2026-08-31.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: commerce-listing-configurations.update3
      with:
        organizationId: tools.organizationId
        configurationId: tools.configurationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: deletes-listing-configuration-will-be
      description: Deletes a Listing Configuration. WILL BE DEPRECATED on 2026-08-31.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: commerce-listing-configurations.delete3
      with:
        organizationId: tools.organizationId
        configurationId: tools.configurationId
      outputParameters:
      - type: object
        mapping: $.