SAP Commerce Cloud Commerce Web Services API — Catalogs

naftiko: 1.0.0-alpha2
info:
  label: SAP Commerce Cloud Commerce Web Services API — Catalogs
  description: 'SAP Commerce Cloud Commerce Web Services API — Catalogs. 3 operations. Lead operation: SAP Commerce Cloud
    List catalogs. Self-contained Naftiko capability covering one Sap Commerce Cloud business surface.'
  tags:
  - Sap Commerce Cloud
  - Catalogs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SAP_COMMERCE_CLOUD_API_KEY: SAP_COMMERCE_CLOUD_API_KEY
capability:
  consumes:
  - type: http
    namespace: commerce-web-services-catalogs
    baseUri: https://{tenant}.{region}.commercecloud.sap/occ/v2/{baseSiteId}
    description: SAP Commerce Cloud Commerce Web Services API — Catalogs business capability. Self-contained, no shared references.
    resources:
    - name: catalogs
      path: /catalogs
      operations:
      - name: getcatalogs
        method: GET
        description: SAP Commerce Cloud List catalogs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: catalogs-catalogId
      path: /catalogs/{catalogId}
      operations:
      - name: getcatalog
        method: GET
        description: SAP Commerce Cloud Get catalog details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: catalogId
          in: path
          type: string
          description: Catalog identifier
          required: true
    - name: catalogs-catalogId-catalogVersionId-categories-categoryId
      path: /catalogs/{catalogId}/{catalogVersionId}/categories/{categoryId}
      operations:
      - name: getcatalogcategory
        method: GET
        description: SAP Commerce Cloud Get category details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: catalogId
          in: path
          type: string
          description: Catalog identifier
          required: true
        - name: catalogVersionId
          in: path
          type: string
          description: Catalog version identifier
          required: true
        - name: categoryId
          in: path
          type: string
          description: Category identifier
          required: true
    authentication:
      type: bearer
      token: '{{env.SAP_COMMERCE_CLOUD_API_KEY}}'
  exposes:
  - type: rest
    namespace: commerce-web-services-catalogs-rest
    port: 8080
    description: REST adapter for SAP Commerce Cloud Commerce Web Services API — Catalogs. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/catalogs
      name: catalogs
      description: REST surface for catalogs.
      operations:
      - method: GET
        name: getcatalogs
        description: SAP Commerce Cloud List catalogs
        call: commerce-web-services-catalogs.getcatalogs
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/catalogs/{catalogid}
      name: catalogs-catalogid
      description: REST surface for catalogs-catalogId.
      operations:
      - method: GET
        name: getcatalog
        description: SAP Commerce Cloud Get catalog details
        call: commerce-web-services-catalogs.getcatalog
        with:
          catalogId: rest.catalogId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/catalogs/{catalogid}/{catalogversionid}/categories/{categoryid}
      name: catalogs-catalogid-catalogversionid-categories-categoryid
      description: REST surface for catalogs-catalogId-catalogVersionId-categories-categoryId.
      operations:
      - method: GET
        name: getcatalogcategory
        description: SAP Commerce Cloud Get category details
        call: commerce-web-services-catalogs.getcatalogcategory
        with:
          catalogId: rest.catalogId
          catalogVersionId: rest.catalogVersionId
          categoryId: rest.categoryId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: commerce-web-services-catalogs-mcp
    port: 9090
    transport: http
    description: MCP adapter for SAP Commerce Cloud Commerce Web Services API — Catalogs. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: sap-commerce-cloud-list-catalogs
      description: SAP Commerce Cloud List catalogs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-web-services-catalogs.getcatalogs
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-get-catalog
      description: SAP Commerce Cloud Get catalog details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-web-services-catalogs.getcatalog
      with:
        catalogId: tools.catalogId
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-get-category
      description: SAP Commerce Cloud Get category details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-web-services-catalogs.getcatalogcategory
      with:
        catalogId: tools.catalogId
        catalogVersionId: tools.catalogVersionId
        categoryId: tools.categoryId
      outputParameters:
      - type: object
        mapping: $.