Coveo Commerce API — Public Listing Page API

naftiko: 1.0.0-alpha2
info:
  label: Coveo Commerce API — Public Listing Page API
  description: 'Coveo Commerce API — Public Listing Page API. 4 operations. Lead operation: Retrieves All Listing Pages and
    Their Page Rules for a Tracking ID Within an Organization. Self-contained Naftiko capability covering one Coveo business
    surface.'
  tags:
  - Coveo
  - Commerce
  - Public Listing Page API
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_SEARCH_TOKEN: COVEO_SEARCH_TOKEN
capability:
  consumes:
  - type: http
    namespace: commerce-public-listing-page-api
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Commerce API — Public Listing Page API business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: rest-organizations-organizationId-commerce-v2-listings-pages
      path: /rest/organizations/{organizationId}/commerce/v2/listings/pages
      operations:
      - name: getall2
        method: GET
        description: Retrieves All Listing Pages and Their Page Rules for a Tracking ID Within an 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: 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: filter
          in: query
          type: string
          description: A filter expressed in JSON logic format.
    - name: rest-organizations-organizationId-commerce-v2-listings-pages-bulk-create
      path: /rest/organizations/{organizationId}/commerce/v2/listings/pages/bulk-create
      operations:
      - name: bulkcreate1
        method: POST
        description: Create Multiple Listing Pages
        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-listings-pages-bulk-delete
      path: /rest/organizations/{organizationId}/commerce/v2/listings/pages/bulk-delete
      operations:
      - name: bulkdelete
        method: POST
        description: Delete Multiple Listing Pages
        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-listings-pages-bulk-update
      path: /rest/organizations/{organizationId}/commerce/v2/listings/pages/bulk-update
      operations:
      - name: bulkupdate1
        method: PUT
        description: Update Multiple Listing Pages
        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
  exposes:
  - type: rest
    namespace: commerce-public-listing-page-api-rest
    port: 8080
    description: REST adapter for Coveo Commerce API — Public Listing Page API. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/commerce/v2/listings/pages
      name: rest-organizations-organizationid-commerce-v2-listings-pages
      description: REST surface for rest-organizations-organizationId-commerce-v2-listings-pages.
      operations:
      - method: GET
        name: getall2
        description: Retrieves All Listing Pages and Their Page Rules for a Tracking ID Within an Organization
        call: commerce-public-listing-page-api.getall2
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          page: rest.page
          perPage: rest.perPage
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/commerce/v2/listings/pages/bulk-create
      name: rest-organizations-organizationid-commerce-v2-listings-pages-bulk-create
      description: REST surface for rest-organizations-organizationId-commerce-v2-listings-pages-bulk-create.
      operations:
      - method: POST
        name: bulkcreate1
        description: Create Multiple Listing Pages
        call: commerce-public-listing-page-api.bulkcreate1
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/commerce/v2/listings/pages/bulk-delete
      name: rest-organizations-organizationid-commerce-v2-listings-pages-bulk-delete
      description: REST surface for rest-organizations-organizationId-commerce-v2-listings-pages-bulk-delete.
      operations:
      - method: POST
        name: bulkdelete
        description: Delete Multiple Listing Pages
        call: commerce-public-listing-page-api.bulkdelete
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/commerce/v2/listings/pages/bulk-update
      name: rest-organizations-organizationid-commerce-v2-listings-pages-bulk-update
      description: REST surface for rest-organizations-organizationId-commerce-v2-listings-pages-bulk-update.
      operations:
      - method: PUT
        name: bulkupdate1
        description: Update Multiple Listing Pages
        call: commerce-public-listing-page-api.bulkupdate1
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: commerce-public-listing-page-api-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Commerce API — Public Listing Page API. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: retrieves-all-listing-pages-and
      description: Retrieves All Listing Pages and Their Page Rules for a Tracking ID Within an Organization
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-public-listing-page-api.getall2
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        page: tools.page
        perPage: tools.perPage
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: create-multiple-listing-pages
      description: Create Multiple Listing Pages
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: commerce-public-listing-page-api.bulkcreate1
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-multiple-listing-pages
      description: Delete Multiple Listing Pages
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: commerce-public-listing-page-api.bulkdelete
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-multiple-listing-pages
      description: Update Multiple Listing Pages
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: commerce-public-listing-page-api.bulkupdate1
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.